org.exolab.castor.builder.GroupInfo Class Reference

List of all members.

Public Member Functions
	GroupInfo ()
int	getMaxOccurs ()
int	getMinOccurs ()
boolean	isMultivalued ()
boolean	isRequired ()
boolean	isChoice ()
boolean	isSequence ()
void	setAsAll ()
void	setAsChoice ()
void	setAsSequence ()
void	setMaxOccurs (int maxOccurs)
void	setMinOccurs (int minOccurs)
void	setMultivalued (boolean multivalued)
void	setRequired (boolean required)
Static Public Attributes
static final int	ALL = 0
static final int	CHOICE = 1
static final int	SEQUENCE = 2

---

Detailed Description

A class to hold group information

Author:

Keith Visco

Version:

Revision:

1.1.1.1

Date:

2003/03/03 07:07:43

---

Constructor & Destructor Documentation

org.exolab.castor.builder.GroupInfo.GroupInfo

(

)

Creates a new GroupInfo

---

Member Function Documentation

int org.exolab.castor.builder.GroupInfo.getMaxOccurs

(

)

Returns the maximum occurance for this group

Returns:

the maximum occurance for this group

int org.exolab.castor.builder.GroupInfo.getMinOccurs

(

)

Returns the minimum occurance for this group

Returns:

the minimum occurance for this group

boolean org.exolab.castor.builder.GroupInfo.isChoice

(

)

Returns true if the compositor of this GroupInfo is a choice

Returns:

true if the compositor of this GroupInfo is a choice

References org.exolab.castor.builder.GroupInfo.CHOICE.

Referenced by org.exolab.castor.builder.ClassInfo.isChoice().

boolean org.exolab.castor.builder.GroupInfo.isMultivalued

(

)

Return whether or not the object described by this XMLInfo is multi-valued (appears more than once in the XML document)

Returns:

true if this object can appear more than once

boolean org.exolab.castor.builder.GroupInfo.isRequired

(

)

Return true if the XML object described by this GroupInfo must appear at least once in the XML document (or object model)

Returns:

true if the XML object must appear at least once

boolean org.exolab.castor.builder.GroupInfo.isSequence

(

)

Returns true if the compositor of this GroupInfo is a sequence

Returns:

true if the compositor of this GroupInfo is a sequence

References org.exolab.castor.builder.GroupInfo.SEQUENCE.

Referenced by org.exolab.castor.builder.ClassInfo.isSequence().

void org.exolab.castor.builder.GroupInfo.setAsAll

(

)

Sets the compositor for the fields of this group to be "all".

References org.exolab.castor.builder.GroupInfo.ALL.

Referenced by org.exolab.castor.builder.SourceFactory.createSourceCode().

void org.exolab.castor.builder.GroupInfo.setAsChoice

(

)

Sets the compositor for the fields of this group to be a choice

References org.exolab.castor.builder.GroupInfo.CHOICE.

Referenced by org.exolab.castor.builder.SourceFactory.createSourceCode().

void org.exolab.castor.builder.GroupInfo.setAsSequence

(

)

Sets the compositor for the fields of this group to be a sequence

References org.exolab.castor.builder.GroupInfo.SEQUENCE.

Referenced by org.exolab.castor.builder.SourceFactory.createSourceCode().

void org.exolab.castor.builder.GroupInfo.setMaxOccurs

(

int

maxOccurs

)

Sets the maximum occurance for this group

Parameters:

maxOccurs

the maximum occurance this group must appear

void org.exolab.castor.builder.GroupInfo.setMinOccurs

(

int

minOccurs

)

Sets the minimum occurance for this group

Parameters:

minOccurs

the minimum occurance this group must appear

void org.exolab.castor.builder.GroupInfo.setMultivalued

(

boolean

multivalued

)

Sets whether the XML object can appear more than once in the XML document

Parameters:

multivalued

the boolean indicating whether or not the object can appear more than once

void org.exolab.castor.builder.GroupInfo.setRequired

(

boolean

required

)

Sets whether or not the XML object must appear at least once

Parameters:

required

the flag indicating whether or not this XML object is required

---

Member Data Documentation

final int org.exolab.castor.builder.GroupInfo.ALL = 0 [static]

The compositor value that indicates that all fields are required, but order is not important. default

Referenced by org.exolab.castor.builder.GroupInfo.setAsAll().

final int org.exolab.castor.builder.GroupInfo.CHOICE = 1 [static]

The compositor value that indicates that only one field may be present

Referenced by org.exolab.castor.builder.GroupInfo.isChoice(), and org.exolab.castor.builder.GroupInfo.setAsChoice().

final int org.exolab.castor.builder.GroupInfo.SEQUENCE = 2 [static]

The compositor value that indicates that all fields are required and order is important

Referenced by org.exolab.castor.builder.GroupInfo.isSequence(), and org.exolab.castor.builder.GroupInfo.setAsSequence().

---

The documentation for this class was generated from the following file:

• GroupInfo.java