# com.bea.xml
SchemaField Interface

public interface SchemaField

Represents an element or an attribute declaration.

Related Topics

``SchemaType.getContainerField()``
``SchemaLocalElement``
``SchemaLocalAttribute``

All Known Subinterfaces
  `SchemaGlobalAttribute`, `SchemaGlobalElement`, `SchemaLocalAttribute`, `SchemaLocalElement`

## Method Summary

`public `String`` | `getDefaultText`() The default value as plain text.
`public `XmlAnySimpleType`` | `getDefaultValue`() The default value as a strongly-typed value.
`public `BigInteger`` | `getMaxOccurs`() Returns the maxOccurs value for this particle, or null if it is unbounded.
`public `BigInteger`` | `getMinOccurs`() Returns the minOccurs value for this particle.
`public `QName`` | `getName`() Returns the form-unqualified-or-qualified name.
`public `SchemaType`` | `getType`() Returns the type of this use.
`public boolean` | `isAttribute`() True if this use is an attribute
`public boolean` | `isDefault`() True if a default is supplied.
`public boolean` | `isFixed`() True if the value is fixed.
`public boolean` | `isNillable`() True if nillable; always false for attributes.

## Method Detail

### getDefaultText() Method

    public String getDefaultText()

The default value as plain text. See `SchemaField.isDefault()``` and `SchemaField.isFixed()```.

### getDefaultValue() Method

    public XmlAnySimpleType getDefaultValue()

The default value as a strongly-typed value. See `SchemaField.isDefault()``` and `SchemaField.isFixed()```.

### getMaxOccurs() Method

    public BigInteger getMaxOccurs()

Returns the maxOccurs value for this particle, or null if it is unbounded. If it is not specified explicitly, this defaults to BigInteger.ONE.

### getMinOccurs() Method

    public BigInteger getMinOccurs()

Returns the minOccurs value for this particle. If it is not specified explicitly, this defaults to BigInteger.ONE.

### getName() Method

    public QName getName()

Returns the form-unqualified-or-qualified name.

### getType() Method

    public SchemaType getType()

Returns the type of this use.

### isAttribute() Method

    public boolean isAttribute()

True if this use is an attribute

### isDefault() Method

    public boolean isDefault()

True if a default is supplied. If `SchemaField.isFixed()```, then isDefault is always true.

### isFixed() Method

    public boolean isFixed()

True if the value is fixed.

### isNillable() Method

    public boolean isNillable()

True if nillable; always false for attributes.