step.typedef
Class InheritedFieldDef

java.lang.Object
  |
  +--step.typedef.FieldDef
        |
        +--step.typedef.InheritedFieldDef

All Implemented Interfaces:

Cloneable

public class InheritedFieldDef

extends FieldDef

The definition for a field that is inherited from a parent type.

NOTE: Inherited fields are a Decorator over the field definition of the parent type.

See Also:

LocalFieldDef

Nested Class Summary

Nested classes inherited from class step.typedef.FieldDef

FieldDef.Builder

Constructor Summary

InheritedFieldDef(FieldDef baseField)
Create the definition for an inherited field.

Method Summary

Object	clone() Get a copy (clone) of this definition.
TypeDef	getAltTypeDef() Get an alternate type definition specific to this field.
protected FieldDef	getBaseDefinition() Get the definition that this definition inherits from.
String	getDescription() Get the description of the field.
String	getName() Get the name of the field.
Type	getType() Get the type of the field.
boolean	isModified() Does this definition have modifications over its base definition?
protected void	setAltTypeDef(TypeDef altDef) Set a new, alternate, definition for the type of this field.
protected void	setDescription(String description) Illegal operation.
protected void	setModified(boolean modified)
protected void	setName(String name) Illegal operation.
protected void	setType(Type type) Illegal operation.

Methods inherited from class step.typedef.FieldDef

builder, getAttributes, hasAltTypeDef, merge, setAttributes

Methods inherited from class java.lang.Object

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

Constructor Detail

InheritedFieldDef

public InheritedFieldDef(FieldDef baseField)

Create the definition for an inherited field.

Method Detail

getName

public String getName()

Description copied from class: FieldDef

Get the name of the field.

Specified by:

getName in class FieldDef

setName

protected void setName(String name)

Illegal operation. It is not possible to set the name of an inherited definition.

Specified by:

setName in class FieldDef

Throws:

UnsupportedOperationException - always.

getType

public Type getType()

Description copied from class: FieldDef

Get the type of the field.

Specified by:

getType in class FieldDef

setType

protected void setType(Type type)

Illegal operation. It is not possible to set the type of an inherited definition.

Specified by:

setType in class FieldDef

Throws:

UnsupportedOperationException - always.

getDescription

public String getDescription()

Description copied from class: FieldDef

Get the description of the field.

Specified by:

getDescription in class FieldDef

setDescription

protected void setDescription(String description)

Illegal operation. It is not possible to set the description of an inherited definition.

Specified by:

setDescription in class FieldDef

Throws:

UnsupportedOperationException - always.

getAltTypeDef

public TypeDef getAltTypeDef()

Description copied from class: FieldDef

Get an alternate type definition specific to this field. The alternate definition is normally used to indicate that subfields of this field have extended/overridden attributes.

Specified by:

getAltTypeDef in class FieldDef

setAltTypeDef

protected void setAltTypeDef(TypeDef altDef)

Description copied from class: FieldDef

Set a new, alternate, definition for the type of this field.

Specified by:

setAltTypeDef in class FieldDef

isModified

public boolean isModified()

Does this definition have modifications over its base definition?

setModified

protected void setModified(boolean modified)

clone

public Object clone()

Description copied from class: FieldDef

Get a copy (clone) of this definition.

Specified by:

clone in class FieldDef

getBaseDefinition

protected FieldDef getBaseDefinition()

Get the definition that this definition inherits from.