Class FormatElement

Method Details

• getLabel

  public String getLabel()

  Get format label.

  Returns:

  format label (null if none)

• setLabel

  public void setLabel(String label)

  Set format label. This method changes the qualified name to match the label.

  Parameters:

  label - format label (null if none)

• getQName

  public QName getQName()

  Get format qualified name.

  Returns:

  format qualified name (null if none)

• setQName

  public void setQName(QName qname)

  Set format qualified name. This method changes the label value to match the qualified name.

  Parameters:

  qname - format qualified name (null if none)

• isDefaultFormat

  public boolean isDefaultFormat()

  Check if default format for type.

  Returns:

  true if default for type, false if not

• setDefaultFormat

  public void setDefaultFormat(boolean dflt)

  Set default format for type.

  Parameters:

  dflt - true if default for type, false if not

• getType

  public IClass getType()

  Get value type. This method is only usable after a call to validate(org.jibx.binding.model.ValidationContext).

  Returns:

  default value object

• getTypeName

  public String getTypeName()

  Get value type name.

  Returns:

  value type name

• setTypeName

  public void setTypeName(String value)

  Set value type name.

  Parameters:

  value - type name

• getDefaultText

  public String getDefaultText()

  Get default value text.

  Returns:

  default value text

• getDefault

  public Object getDefault()

  Get default value. This call is only meaningful after validation.

  Returns:

  default value object

• setDefaultText

  public void setDefaultText(String value)

  Set default value text.

  Parameters:

  value - default value text

• getEnumValue

  public IClassItem getEnumValue()

  Get enum value method information. This method is only usable after a call to validate(ValidationContext).

  Returns:

  enum value method information (or null if none)

• getEnumValueName

  public String getEnumValueName()

  Get enum value method name.

  Returns:

  enum value method name (or null if none)

• setEnumValueName

  public void setEnumValueName(String name)

  Set enum value method name.

  Parameters:

  name - enum value method name (null if none)

• getSerializerName

  public String getSerializerName()

  Get serializer name.

  Returns:

  fully qualified class and method name for serializer (or null if none)

• getSerializer

  public IClassItem getSerializer()

  Get serializer method information. This call is only meaningful after validation.

  Returns:

  serializer information (or null if none)

• setSerializerName

  public void setSerializerName(String name)

  Set serializer method name.

  Parameters:

  name - fully qualified class and method name for serializer

• getDeserializerName

  public String getDeserializerName()

  Get deserializer name.

  Returns:

  fully qualified class and method name for deserializer (or null if none)

• getDeserializer

  public IClassItem getDeserializer()

  Get deserializer method information. This call is only meaningful after validation.

  Returns:

  deserializer information (or null if none)

• setDeserializerName

  public void setDeserializerName(String name)

  Set deserializer method name.

  Parameters:

  name - fully qualified class and method name for deserializer

• getBaseFormat

  public FormatElement getBaseFormat()

  Get base format information. This method is only usable after a call to validate(org.jibx.binding.model.ValidationContext).

  Returns:

  base format element (or null if none)

• setQualifiedLabel

  private void setQualifiedLabel(String label, IUnmarshallingContext ictx) throws JiBXException

  JiBX access method to set format label as qualified name.

  Parameters:

  label - format label text (null if none)

  ictx - unmarshalling context

  Throws:

  JiBXException - on deserialization error

• getQualifiedLabel

  private String getQualifiedLabel(IMarshallingContext ictx) throws JiBXException

  JiBX access method to get format label as qualified name.

  Parameters:

  ictx - marshalling context

  Returns:

  format label text (null if none)

  Throws:

  JiBXException - on deserialization error

• preSet

  private void preSet(IUnmarshallingContext uctx) throws JiBXException

  Make sure all attributes are defined.

  Parameters:

  uctx - unmarshalling context

  Throws:

  JiBXException - on unmarshalling error

• postSet

  private void postSet()

  Set default flag based on whether name supplied or not. TODO: use explicit flag for 2.0

• prevalidate

  public void prevalidate(ValidationContext vctx)

  Prevalidate attributes of element in isolation. Note that this adds the format information to the context, which is necessary because the string attributes for values need to have access to the format information for their own prevalidation. This is the only type of registration which is done during the prevalidation pass.

  Overrides:

  prevalidate in class ElementBase

  Parameters:

  vctx - validation context

• validate

  public void validate(ValidationContext vctx)

  Description copied from class: ElementBase

  Validate element information. The validation step is used for checking the interactions between elements, such as name references to other elements. The ElementBase.prevalidate(org.jibx.binding.model.ValidationContext) method will always be called for every element in the binding definition before this method is called for any element. This empty base class implementation should be overridden by each subclass that requires validation handling.

  Overrides:

  validate in class ElementBase

  Parameters:

  vctx - validation context