Package org.jibx.custom.classes

Class SharedNestingBase

java.lang.Object
org.jibx.custom.classes.CustomBase
org.jibx.custom.classes.SharedNestingBase
Direct Known Subclasses:
NestingBase, NestingBase
public abstract class SharedNestingBase extends CustomBase
Base class for all binding customizations that can contain other customizations. This includes inherited values shared with customization extensions (in particular, the WSDL extensions).
Author:
Dennis M. Sosnoski

  • Field Details

    • s_allowedAttributes

      public static final StringArray s_allowedAttributes
      Enumeration of allowed attribute names

    • m_javadocFormatter

      private String m_javadocFormatter

    • m_namespace

      private String m_namespace

    • m_namespaceStyle

      private Integer m_namespaceStyle

    • m_nameStyle

      private Integer m_nameStyle

    • m_require

      private Integer m_require

    • m_useJavaDocs

      private Boolean m_useJavaDocs

    • m_actualNamespace

      private String m_actualNamespace

  • Constructor Details

    • SharedNestingBase

      public SharedNestingBase(SharedNestingBase parent)
      Constructor.
      Parameters:
      parent -

  • Method Details

    • getFormatterClass

      public String getFormatterClass()
      Get JavaDoc formatter class name.
      Returns:
      namespace style

    • getSpecifiedNamespace

      protected String getSpecifiedNamespace()
      Get namespace specified on this element. This method is only intended for use by subclasses - otherwise the getNamespace() method should instead be used.
      Returns:
      namespace (null if none)

    • getNamespaceStyle

      public int getNamespaceStyle()
      Get namespace derivation style.
      Returns:
      namespace style

    • setNamespaceStyle

      public void setNamespaceStyle(Integer style)
      Set namespace derivation style.
      Parameters:
      style - (null if none at this level)

    • getNameStyle

      public int getNameStyle()
      Get name style.
      Returns:
      name style

    • setNameStyle

      public void setNameStyle(Integer style)
      Set name style.
      Parameters:
      style - (null if none at this level)

    • getNamespace

      public final String getNamespace()
      Get the namespace for schema definitions. This value must be set by subclasses using the setNamespace(String) method.
      Returns:
      schema namespace

    • setNamespace

      protected void setNamespace(String ns)
      Set the namespace to be used for schema definitions. This method is only intended for use by subclasses.
      Parameters:
      ns -

    • isPrimitiveRequired

      public boolean isPrimitiveRequired(String type)
      Check if primitive value should be treated as required. If not set at any nesting level, the default is true.
      Parameters:
      type - primitive type
      Returns:
      true if required value, false if not

    • isObjectRequired

      public boolean isObjectRequired(String type)
      Check if object value should be treated as required. If not set at any nesting level, the default is false.
      Parameters:
      type - object type
      Returns:
      true if required value, false if not

    • isUseJavaDocs

      public boolean isUseJavaDocs()
      Check if JavaDocs should be used for documentation. If not set at any nesting level, the default is true.
      Returns:
      force names flag

    • convertName

      public String convertName(String base)
      Convert class or unprefixed field name to element or attribute name using current format.
      Parameters:
      base - class or simple field name to be converted
      Returns:
      element or attribute name

    • setNameStyleText

      private void setNameStyleText(String text, IUnmarshallingContext ictx)
      Name style set text method. This is intended for use during unmarshalling. TODO: add validation
      Parameters:
      text -
      ictx -

    • getNameStyleText

      private String getNameStyleText()
      Name style get text method. This is intended for use during marshalling.
      Returns:
      text

    • setNamespaceStyleText

      private void setNamespaceStyleText(String text, IUnmarshallingContext ictx)
      Namespace style set text method. This is intended for use during unmarshalling. TODO: add validation
      Parameters:
      text -
      ictx -

    • getNamespaceStyleText

      private String getNamespaceStyleText()
      Namespace style get text method. This is intended for use during marshalling.
      Returns:
      text

    • setRequireText

      private void setRequireText(String text, IUnmarshallingContext ictx)
      Required set text method. This is intended for use during unmarshalling. TODO: add validation
      Parameters:
      text -
      ictx -

    • getRequireText

      private String getRequireText()
      Required get text method. This is intended for use during marshalling.
      Returns:
      text