Element (GlassFish HK2 2.5.0 API)

All Superinterfaces:: Annotated, OpenAttrs

All Known Subinterfaces:: LocalElement, NarrowMaxMin, TopLevelElement

@Contract
 @Hk2XmlPreGenerate
public interface Element
extends Annotated

The element element can be used either at the top level to define an element-type binding globally, or within a content model to either reference a globally-defined element or type or declare an element-type binding locally. The ref form is not allowed at the top level.

Java class for element complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="element">
   <complexContent>
     <extension base="{http://www.w3.org/2001/XMLSchema}annotated">
       <sequence>
         <choice minOccurs="0">
           <element name="simpleType" type="{http://www.w3.org/2001/XMLSchema}localSimpleType"/>
           <element name="complexType" type="{http://www.w3.org/2001/XMLSchema}localComplexType"/>
         </choice>
         <group ref="{http://www.w3.org/2001/XMLSchema}identityConstraint" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attGroup ref="{http://www.w3.org/2001/XMLSchema}defRef"/>
       <attGroup ref="{http://www.w3.org/2001/XMLSchema}occurs"/>
       <attribute name="type" type="{http://www.w3.org/2001/XMLSchema}QName" />
       <attribute name="substitutionGroup" type="{http://www.w3.org/2001/XMLSchema}QName" />
       <attribute name="default" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="fixed" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="nillable" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="abstract" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="final" type="{http://www.w3.org/2001/XMLSchema}derivationSet" />
       <attribute name="block" type="{http://www.w3.org/2001/XMLSchema}blockSet" />
       <attribute name="form" type="{http://www.w3.org/2001/XMLSchema}formChoice" />
       <anyAttribute processContents='lax' namespace='##other'/>
     </extension>
   </complexContent>
 </complexType>

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`List<String>`	`getBlock()` Gets the value of the block property.
`LocalComplexType`	`getComplexType()` Gets the value of the complexType property.
`String`	`getDefault()` Gets the value of the default property.
`List<String>`	`getFinal()` Gets the value of the final property.
`String`	`getFixed()` Gets the value of the fixed property.
`FormChoice`	`getForm()` Gets the value of the form property.
`List<Object>`	`getIdentityConstraint()` Gets the value of the identityConstraint property.
`String`	`getMaxOccurs()` Gets the value of the maxOccurs property.
`BigInteger`	`getMinOccurs()` Gets the value of the minOccurs property.
`String`	`getName()` Gets the value of the name property.
`QName`	`getRef()` Gets the value of the ref property.
`LocalSimpleType`	`getSimpleType()` Gets the value of the simpleType property.
`QName`	`getSubstitutionGroup()` Gets the value of the substitutionGroup property.
`QName`	`getType()` Gets the value of the type property.
`boolean`	`isAbstract()` Gets the value of the abstract property.
`boolean`	`isNillable()` Gets the value of the nillable property.
`void`	`setAbstract(Boolean value)` Sets the value of the abstract property.
`void`	`setComplexType(LocalComplexType value)` Sets the value of the complexType property.
`void`	`setDefault(String value)` Sets the value of the default property.
`void`	`setFixed(String value)` Sets the value of the fixed property.
`void`	`setForm(FormChoice value)` Sets the value of the form property.
`void`	`setMaxOccurs(String value)` Sets the value of the maxOccurs property.
`void`	`setMinOccurs(BigInteger value)` Sets the value of the minOccurs property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setNillable(Boolean value)` Sets the value of the nillable property.
`void`	`setRef(QName value)` Sets the value of the ref property.
`void`	`setSimpleType(LocalSimpleType value)` Sets the value of the simpleType property.
`void`	`setSubstitutionGroup(QName value)` Sets the value of the substitutionGroup property.
`void`	`setType(QName value)` Sets the value of the type property.

Methods inherited from interface org.glassfish.hk2.xml.schema.beans.Annotated
getAnnotation, getId, setAnnotation, setId

Methods inherited from interface org.glassfish.hk2.xml.schema.beans.OpenAttrs
getOtherAttributes, setOtherAttributes

- Method Detail
  - getSimpleType
```
LocalSimpleType getSimpleType()
```
    Gets the value of the simpleType property.
    
    Returns:
    
    possible object is LocalSimpleType
  - setSimpleType
```
void setSimpleType(LocalSimpleType value)
```
    Sets the value of the simpleType property.
    
    Parameters:
    
    value - allowed object is LocalSimpleType
  - getComplexType
```
LocalComplexType getComplexType()
```
    Gets the value of the complexType property.
    
    Returns:
    
    possible object is LocalComplexType
  - setComplexType
```
void setComplexType(LocalComplexType value)
```
    Sets the value of the complexType property.
    
    Parameters:
    
    value - allowed object is LocalComplexType
  - getIdentityConstraint
```
List<Object> getIdentityConstraint()
```
    Gets the value of the identityConstraint property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the identityConstraint property.
    For example, to add a new item, do as follows:
```
    getIdentityConstraint().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Keyref JAXBElement<Keybase> JAXBElement<Keybase>
  - getType
```
QName getType()
```
    Gets the value of the type property.
    
    Returns:
    
    possible object is QName
  - setType
```
void setType(QName value)
```
    Sets the value of the type property.
    
    Parameters:
    
    value - allowed object is QName
  - getSubstitutionGroup
```
QName getSubstitutionGroup()
```
    Gets the value of the substitutionGroup property.
    
    Returns:
    
    possible object is QName
  - setSubstitutionGroup
```
void setSubstitutionGroup(QName value)
```
    Sets the value of the substitutionGroup property.
    
    Parameters:
    
    value - allowed object is QName
  - getDefault
```
String getDefault()
```
    Gets the value of the default property.
    
    Returns:
    
    possible object is String
  - setDefault
```
void setDefault(String value)
```
    Sets the value of the default property.
    
    Parameters:
    
    value - allowed object is String
  - getFixed
```
String getFixed()
```
    Gets the value of the fixed property.
    
    Returns:
    
    possible object is String
  - setFixed
```
void setFixed(String value)
```
    Sets the value of the fixed property.
    
    Parameters:
    
    value - allowed object is String
  - isNillable
```
boolean isNillable()
```
    Gets the value of the nillable property.
    
    Returns:
    
    possible object is Boolean
  - setNillable
```
void setNillable(Boolean value)
```
    Sets the value of the nillable property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isAbstract
```
boolean isAbstract()
```
    Gets the value of the abstract property.
    
    Returns:
    
    possible object is Boolean
  - setAbstract
```
void setAbstract(Boolean value)
```
    Sets the value of the abstract property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getFinal
```
List<String> getFinal()
```
    Gets the value of the final property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the final property.
    For example, to add a new item, do as follows:
```
    getFinal().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String
  - getBlock
```
List<String> getBlock()
```
    Gets the value of the block property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the block property.
    For example, to add a new item, do as follows:
```
    getBlock().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String
  - getForm
```
FormChoice getForm()
```
    Gets the value of the form property.
    
    Returns:
    
    possible object is FormChoice
  - setForm
```
void setForm(FormChoice value)
```
    Sets the value of the form property.
    
    Parameters:
    
    value - allowed object is FormChoice
  - getName
```
String getName()
```
    Gets the value of the name property.
    
    Returns:
    
    possible object is String
  - setName
```
void setName(String value)
```
    Sets the value of the name property.
    
    Parameters:
    
    value - allowed object is String
  - getRef
```
QName getRef()
```
    Gets the value of the ref property.
    
    Returns:
    
    possible object is QName
  - setRef
```
void setRef(QName value)
```
    Sets the value of the ref property.
    
    Parameters:
    
    value - allowed object is QName
  - getMinOccurs
```
BigInteger getMinOccurs()
```
    Gets the value of the minOccurs property.
    
    Returns:
    
    possible object is BigInteger
  - setMinOccurs
```
void setMinOccurs(BigInteger value)
```
    Sets the value of the minOccurs property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - getMaxOccurs
```
String getMaxOccurs()
```
    Gets the value of the maxOccurs property.
    
    Returns:
    
    possible object is String
  - setMaxOccurs
```
void setMaxOccurs(String value)
```
    Sets the value of the maxOccurs property.
    
    Parameters:
    
    value - allowed object is String

Interface Element

Method Summary

Methods inherited from interface org.glassfish.hk2.xml.schema.beans.Annotated

Methods inherited from interface org.glassfish.hk2.xml.schema.beans.OpenAttrs

Method Detail

getSimpleType

setSimpleType

getComplexType

setComplexType

getIdentityConstraint

getType

setType

getSubstitutionGroup

setSubstitutionGroup

getDefault

setDefault

getFixed

setFixed

isNillable

setNillable

isAbstract

setAbstract

getFinal

getBlock

getForm

setForm

getName

setName

getRef

setRef

getMinOccurs

setMinOccurs

getMaxOccurs

setMaxOccurs