Class TextLabel

  • All Implemented Interfaces:
    Label

    class TextLabel
    extends TemplateLabel
    The TextLabel represents a label that is used to get a converter for a text entry within an XML element. This label is used to convert an XML text entry into a primitive value such as a string or an integer, this will throw an exception if the field value does not represent a primitive object.
    See Also:
    Text
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private Contact contact
      The contact that this annotation label represents.
      private boolean data
      This is used to determine if the attribute is data.
      private Introspector detail
      This represents the signature of the annotated contact.
      private java.lang.String empty
      This is the default value to use if the real value is null.
      private Text label
      References the annotation that was used by the contact.
      private Expression path
      This is the path that is used to represent this text.
      private boolean required
      This is used to determine if the attribute is required.
      private java.lang.Class type
      This is the type of the class that the field references.
    • Constructor Summary

      Constructors 
      Constructor Description
      TextLabel​(Contact contact, Text label, Format format)
      Constructor for the TextLabel object.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.annotation.Annotation getAnnotation()
      This acquires the annotation associated with this label.
      Contact getContact()
      This is used to acquire the contact object for this label.
      Converter getConverter​(Context context)
      Creates a converter that can be used to transform an XML node to an object and vice versa.
      Decorator getDecorator()
      This is used to acquire the Decorator for this.
      java.lang.String getEmpty​(Context context)
      This is used to provide a configured empty value used when the annotated value is null.
      Expression getExpression()
      This method is used to return an XPath expression that is used to represent the position of this label.
      java.lang.String getName()
      This is used to acquire the name of the element or attribute that is used by the class schema.
      java.lang.String getOverride()
      This is used to acquire the name of the element or attribute as taken from the annotation.
      java.lang.String getPath()
      This is used to acquire the path of the element or attribute that is used by the class schema.
      java.lang.Class getType()
      This acts as a convenience method used to determine the type of contact this represents.
      boolean isData()
      This is used to determine if the Text method or field is to have its value written as a CDATA block.
      boolean isInline()
      This method is used by the deserialization process to check to see if an annotation is inline or not.
      boolean isRequired()
      This is used to determine whether the XML element is required.
      boolean isText()
      This is used to determine if the label represents text.
      java.lang.String toString()
      This is used to describe the annotation and method or field that this label represents.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • detail

        private Introspector detail
        This represents the signature of the annotated contact.
      • path

        private Expression path
        This is the path that is used to represent this text.
      • contact

        private Contact contact
        The contact that this annotation label represents.
      • label

        private Text label
        References the annotation that was used by the contact.
      • type

        private java.lang.Class type
        This is the type of the class that the field references.
      • empty

        private java.lang.String empty
        This is the default value to use if the real value is null.
      • required

        private boolean required
        This is used to determine if the attribute is required.
      • data

        private boolean data
        This is used to determine if the attribute is data.
    • Constructor Detail

      • TextLabel

        public TextLabel​(Contact contact,
                         Text label,
                         Format format)
        Constructor for the TextLabel object. This is used to create a label that can convert a XML node into a primitive value from an XML element text value.
        Parameters:
        contact - this is the contact this label represents
        label - this is the annotation for the contact
        format - this is the format used for this label
    • Method Detail

      • getDecorator

        public Decorator getDecorator()
                               throws java.lang.Exception
        This is used to acquire the Decorator for this. A decorator is an object that adds various details to the node without changing the overall structure of the node. For example comments and namespaces can be added to the node with a decorator as they do not affect the deserialization.
        Returns:
        this returns the decorator associated with this
        Throws:
        java.lang.Exception
      • getConverter

        public Converter getConverter​(Context context)
                               throws java.lang.Exception
        Creates a converter that can be used to transform an XML node to an object and vice versa. The converter created will handles only XML text and requires the context object to be provided.
        Parameters:
        context - this is the context object used for serialization
        Returns:
        this returns a converter for serializing XML elements
        Throws:
        java.lang.Exception
      • getEmpty

        public java.lang.String getEmpty​(Context context)
        This is used to provide a configured empty value used when the annotated value is null. This ensures that XML can be created with required details regardless of whether values are null or not. It also provides a means for sensible default values.
        Parameters:
        context - this is the context object for the serialization
        Returns:
        this returns the string to use for default values
      • getPath

        public java.lang.String getPath()
                                 throws java.lang.Exception
        This is used to acquire the path of the element or attribute that is used by the class schema. The path is determined by acquiring the XPath expression and appending the name of the label to form a fully qualified path.
        Returns:
        returns the path that is used for the XML property
        Throws:
        java.lang.Exception
      • getExpression

        public Expression getExpression()
                                 throws java.lang.Exception
        This method is used to return an XPath expression that is used to represent the position of this label. If there is no XPath expression associated with this then an empty path is returned. This will never return a null expression.
        Returns:
        the XPath expression identifying the location
        Throws:
        java.lang.Exception
      • getAnnotation

        public java.lang.annotation.Annotation getAnnotation()
        This acquires the annotation associated with this label. This is typically the annotation acquired from the field or method. However, in the case of unions this will return the actual annotation within the union group that this represents.
        Returns:
        this returns the annotation that this represents
      • getContact

        public Contact getContact()
        This is used to acquire the contact object for this label. The contact retrieved can be used to set any object or primitive that has been deserialized, and can also be used to acquire values to be serialized in the case of object persistence. All contacts that are retrieved from this method will be accessible.
        Returns:
        returns the contact that this label is representing
      • getName

        public java.lang.String getName()
        This is used to acquire the name of the element or attribute that is used by the class schema. The name is determined by checking for an override within the annotation. If it contains a name then that is used, if however the annotation does not specify a name the the field or method name is used instead.
        Returns:
        returns the name that is used for the XML property
      • getOverride

        public java.lang.String getOverride()
        This is used to acquire the name of the element or attribute as taken from the annotation. If the element or attribute explicitly specifies a name then that name is used for the XML element or attribute used. If however no overriding name is provided then the method or field is used for the name.
        Returns:
        returns the name of the annotation for the contact
      • getType

        public java.lang.Class getType()
        This acts as a convenience method used to determine the type of contact this represents. This is used when an object is written to XML. It determines whether a class attribute is required within the serialized XML element, that is, if the class returned by this is different from the actual value of the object to be serialized then that type needs to be remembered.
        Returns:
        this returns the type of the contact class
      • isRequired

        public boolean isRequired()
        This is used to determine whether the XML element is required. This ensures that if an XML element is missing from a document that deserialization can continue. Also, in the process of serialization, if a value is null it does not need to be written to the resulting XML document.
        Returns:
        true if the label represents a some required data
      • isData

        public boolean isData()
        This is used to determine if the Text method or field is to have its value written as a CDATA block. This will set the output node to CDATA mode if this returns true, if it is false data will be written according to an inherited mode. By default inherited mode results in escaped XML text.
        Returns:
        this returns true if the text is to be a CDATA block
      • isText

        public boolean isText()
        This is used to determine if the label represents text. If a label represents text it typically does not have a name, instead the empty string represents the name. Also text labels can not exist with other text labels, or elements.
        Specified by:
        isText in interface Label
        Overrides:
        isText in class TemplateLabel
        Returns:
        this returns true if this label represents text
      • isInline

        public boolean isInline()
        This method is used by the deserialization process to check to see if an annotation is inline or not. If an annotation represents an inline XML entity then the deserialization and serialization process ignores overrides and special attributes. By default all text entities are inline.
        Specified by:
        isInline in interface Label
        Overrides:
        isInline in class TemplateLabel
        Returns:
        this always returns true for text labels
      • toString

        public java.lang.String toString()
        This is used to describe the annotation and method or field that this label represents. This is used to provide error messages that can be used to debug issues that occur when processing a method. This will provide enough information such that the problem can be isolated correctly.
        Specified by:
        toString in interface Label
        Overrides:
        toString in class java.lang.Object
        Returns:
        this returns a string representation of the label