Package org.spiritconsortium.SPIRIT_1685_2009

Class FieldType

java.lang.Object

org.spiritconsortium.SPIRIT_1685_2009.FieldType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public class FieldType
extends java.lang.Object

A field within a register

Java class for fieldType complex type.

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

 <complexType name="fieldType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <group ref="{http://www.spiritconsortium.org/XMLSchema/SPIRIT/1685-2009}nameGroup"/>
         <element name="bitOffset" type="{http://www.w3.org/2001/XMLSchema}nonNegativeInteger"/>
         <group ref="{http://www.spiritconsortium.org/XMLSchema/SPIRIT/1685-2009}fieldDefinitionGroup"/>
         <element ref="{http://www.spiritconsortium.org/XMLSchema/SPIRIT/1685-2009}parameters" minOccurs="0"/>
         <element ref="{http://www.spiritconsortium.org/XMLSchema/SPIRIT/1685-2009}vendorExtensions" minOccurs="0"/>
       </sequence>
       <attribute ref="{http://www.spiritconsortium.org/XMLSchema/SPIRIT/1685-2009}id"/>
     </restriction>
   </complexContent>
 </complexType>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FieldType.BitWidth	Java class for anonymous complex type.
static class	FieldType.Testable	Java class for anonymous complex type.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.Boolean	_volatile
protected AccessType	access
protected java.math.BigInteger	bitOffset
protected FieldType.BitWidth	bitWidth
protected java.lang.String	description
protected java.lang.String	displayName
protected EnumeratedValues	enumeratedValues
protected java.lang.String	id
protected java.lang.String	modifiedWriteValue
protected java.lang.String	name
protected Parameters	parameters
protected java.lang.String	readAction
protected FieldType.Testable	testable
protected java.lang.String	typeIdentifier
protected VendorExtensions	vendorExtensions
protected WriteValueConstraintType	writeValueConstraint

Constructor Summary

Constructors

Constructor	Description
FieldType()

Method Summary

Modifier and Type	Method	Description
AccessType	getAccess()	Gets the value of the access property.
java.math.BigInteger	getBitOffset()	Gets the value of the bitOffset property.
FieldType.BitWidth	getBitWidth()	Gets the value of the bitWidth property.
java.lang.String	getDescription()	Gets the value of the description property.
java.lang.String	getDisplayName()	Gets the value of the displayName property.
EnumeratedValues	getEnumeratedValues()	Gets the value of the enumeratedValues property.
java.lang.String	getId()	Gets the value of the id property.
java.lang.String	getModifiedWriteValue()	Gets the value of the modifiedWriteValue property.
java.lang.String	getName()	Gets the value of the name property.
Parameters	getParameters()	Gets the value of the parameters property.
java.lang.String	getReadAction()	Gets the value of the readAction property.
FieldType.Testable	getTestable()	Gets the value of the testable property.
java.lang.String	getTypeIdentifier()	Gets the value of the typeIdentifier property.
VendorExtensions	getVendorExtensions()	Gets the value of the vendorExtensions property.
WriteValueConstraintType	getWriteValueConstraint()	Gets the value of the writeValueConstraint property.
java.lang.Boolean	isVolatile()	Indicates whether the data is volatile.
void	setAccess(AccessType value)	Sets the value of the access property.
void	setBitOffset(java.math.BigInteger value)	Sets the value of the bitOffset property.
void	setBitWidth(FieldType.BitWidth value)	Sets the value of the bitWidth property.
void	setDescription(java.lang.String value)	Sets the value of the description property.
void	setDisplayName(java.lang.String value)	Sets the value of the displayName property.
void	setEnumeratedValues(EnumeratedValues value)	Sets the value of the enumeratedValues property.
void	setId(java.lang.String value)	Sets the value of the id property.
void	setModifiedWriteValue(java.lang.String value)	Sets the value of the modifiedWriteValue property.
void	setName(java.lang.String value)	Sets the value of the name property.
void	setParameters(Parameters value)	Sets the value of the parameters property.
void	setReadAction(java.lang.String value)	Sets the value of the readAction property.
void	setTestable(FieldType.Testable value)	Sets the value of the testable property.
void	setTypeIdentifier(java.lang.String value)	Sets the value of the typeIdentifier property.
void	setVendorExtensions(VendorExtensions value)	Sets the value of the vendorExtensions property.
void	setVolatile(java.lang.Boolean value)	Sets the value of the volatile property.
void	setWriteValueConstraint(WriteValueConstraintType value)	Sets the value of the writeValueConstraint property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
protected java.lang.String name

displayName

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
protected java.lang.String displayName

description

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
protected java.lang.String description

bitOffset

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
protected java.math.BigInteger bitOffset

typeIdentifier

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
protected java.lang.String typeIdentifier

bitWidth

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
protected FieldType.BitWidth bitWidth

_volatile

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
protected java.lang.Boolean _volatile

access

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
protected AccessType access

enumeratedValues

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
protected EnumeratedValues enumeratedValues

modifiedWriteValue

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
protected java.lang.String modifiedWriteValue

writeValueConstraint

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
protected WriteValueConstraintType writeValueConstraint

readAction

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
protected java.lang.String readAction

testable

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
protected FieldType.Testable testable

parameters

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
protected Parameters parameters

vendorExtensions

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
protected VendorExtensions vendorExtensions

id

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
protected java.lang.String id

Constructor Detail

FieldType

public FieldType()

Method Detail

getName

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public java.lang.String getName()

Gets the value of the name property.

Returns:

possible object is String

setName

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public void setName(java.lang.String value)

Sets the value of the name property.

Parameters:

value - allowed object is String

getDisplayName

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public java.lang.String getDisplayName()

Gets the value of the displayName property.

Returns:

possible object is String

setDisplayName

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public void setDisplayName(java.lang.String value)

Sets the value of the displayName property.

Parameters:

value - allowed object is String

getDescription

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public java.lang.String getDescription()

Gets the value of the description property.

Returns:

possible object is String

setDescription

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public void setDescription(java.lang.String value)

Sets the value of the description property.

Parameters:

value - allowed object is String

getBitOffset

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public java.math.BigInteger getBitOffset()

Gets the value of the bitOffset property.

Returns:

possible object is BigInteger

setBitOffset

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public void setBitOffset(java.math.BigInteger value)

Sets the value of the bitOffset property.

Parameters:

value - allowed object is BigInteger

getTypeIdentifier

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public java.lang.String getTypeIdentifier()

Gets the value of the typeIdentifier property.

Returns:

possible object is String

setTypeIdentifier

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public void setTypeIdentifier(java.lang.String value)

Sets the value of the typeIdentifier property.

Parameters:

value - allowed object is String

getBitWidth

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public FieldType.BitWidth getBitWidth()

Gets the value of the bitWidth property.

Returns:

possible object is FieldType.BitWidth

setBitWidth

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public void setBitWidth(FieldType.BitWidth value)

Sets the value of the bitWidth property.

Parameters:

value - allowed object is FieldType.BitWidth

isVolatile

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public java.lang.Boolean isVolatile()

Indicates whether the data is volatile. The presumed value is 'false' if not present.

Returns:

possible object is Boolean

setVolatile

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public void setVolatile(java.lang.Boolean value)

Sets the value of the volatile property.

Parameters:

value - allowed object is Boolean

getAccess

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public AccessType getAccess()

Gets the value of the access property.

Returns:

possible object is AccessType

setAccess

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public void setAccess(AccessType value)

Sets the value of the access property.

Parameters:

value - allowed object is AccessType

getEnumeratedValues

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public EnumeratedValues getEnumeratedValues()

Gets the value of the enumeratedValues property.

Returns:

possible object is EnumeratedValues

setEnumeratedValues

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public void setEnumeratedValues(EnumeratedValues value)

Sets the value of the enumeratedValues property.

Parameters:

value - allowed object is EnumeratedValues

getModifiedWriteValue

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public java.lang.String getModifiedWriteValue()

Gets the value of the modifiedWriteValue property.

Returns:

possible object is String

setModifiedWriteValue

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public void setModifiedWriteValue(java.lang.String value)

Sets the value of the modifiedWriteValue property.

Parameters:

value - allowed object is String

getWriteValueConstraint

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public WriteValueConstraintType getWriteValueConstraint()

Gets the value of the writeValueConstraint property.

Returns:

possible object is WriteValueConstraintType

setWriteValueConstraint

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public void setWriteValueConstraint(WriteValueConstraintType value)

Sets the value of the writeValueConstraint property.

Parameters:

value - allowed object is WriteValueConstraintType

getReadAction

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public java.lang.String getReadAction()

Gets the value of the readAction property.

Returns:

possible object is String

setReadAction

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public void setReadAction(java.lang.String value)

Sets the value of the readAction property.

Parameters:

value - allowed object is String

getTestable

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public FieldType.Testable getTestable()

Gets the value of the testable property.

Returns:

possible object is FieldType.Testable

setTestable

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public void setTestable(FieldType.Testable value)

Sets the value of the testable property.

Parameters:

value - allowed object is FieldType.Testable

getParameters

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public Parameters getParameters()

Gets the value of the parameters property.

Returns:

possible object is Parameters

setParameters

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public void setParameters(Parameters value)

Sets the value of the parameters property.

Parameters:

value - allowed object is Parameters

getVendorExtensions

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public VendorExtensions getVendorExtensions()

Gets the value of the vendorExtensions property.

Returns:

possible object is VendorExtensions

setVendorExtensions

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public void setVendorExtensions(VendorExtensions value)

Sets the value of the vendorExtensions property.

Parameters:

value - allowed object is VendorExtensions

getId

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public java.lang.String getId()

Gets the value of the id property.

Returns:

possible object is String

setId

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.8",
           date="2026-01-14T04:58:58Z")
public void setId(java.lang.String value)

Sets the value of the id property.

Parameters:

value - allowed object is String