Class HyphenStyle

  • All Implemented Interfaces:
    Style

    public class HyphenStyle
    extends java.lang.Object
    implements Style
    The HyphenStyle is used to represent an XML style that can be applied to a serialized object. A style can be used to modify the element and attribute names for the generated document. This styles can be used to generate hyphenated XML.
     
        <example-element>
            <child-element example-attribute='example'>
               <inner-element>example</inner-element>
            </child-element>
         </example-element>
         
     
    Above the hyphenated XML elements and attributes can be generated from a style implementation. Styles enable the same objects to be serialized in different ways, generating different styles of XML without having to modify the class schema for that object.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private Builder builder
      This is used to perform the actual building of tokens.
      private Style style
      This is the strategy used to generate the style tokens.
    • Constructor Summary

      Constructors 
      Constructor Description
      HyphenStyle()
      Constructor for the HyphenStyle object.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getAttribute​(java.lang.String name)
      This is used to generate the XML attribute representation of the specified name.
      java.lang.String getElement​(java.lang.String name)
      This is used to generate the XML element representation of the specified name.
      void setAttribute​(java.lang.String name, java.lang.String value)
      This is used to set the attribute values within this builder.
      void setElement​(java.lang.String name, java.lang.String value)
      This is used to set the element values within this builder.
      • Methods inherited from class java.lang.Object

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

      • builder

        private final Builder builder
        This is used to perform the actual building of tokens.
      • style

        private final Style style
        This is the strategy used to generate the style tokens.
    • Constructor Detail

      • HyphenStyle

        public HyphenStyle()
        Constructor for the HyphenStyle object. This is used to create a style that will hyphenate XML attributes and elements allowing a consistent format for generated XML.
    • Method Detail

      • getAttribute

        public java.lang.String getAttribute​(java.lang.String name)
        This is used to generate the XML attribute representation of the specified name. Attribute names should ensure to keep the uniqueness of the name such that two different names will be styled in to two different strings.
        Specified by:
        getAttribute in interface Style
        Parameters:
        name - this is the attribute name that is to be styled
        Returns:
        this returns the styled name of the XML attribute
      • setAttribute

        public void setAttribute​(java.lang.String name,
                                 java.lang.String value)
        This is used to set the attribute values within this builder. Overriding the attribute values ensures that the default algorithm does not need to determine each of the values. It allows special behaviour that the user may require for XML.
        Parameters:
        name - the name of the XML attribute to be overridden
        value - the value that is to be used for that attribute
      • getElement

        public java.lang.String getElement​(java.lang.String name)
        This is used to generate the XML element representation of the specified name. Element names should ensure to keep the uniqueness of the name such that two different names will be styled in to two different strings.
        Specified by:
        getElement in interface Style
        Parameters:
        name - this is the element name that is to be styled
        Returns:
        this returns the styled name of the XML element
      • setElement

        public void setElement​(java.lang.String name,
                               java.lang.String value)
        This is used to set the element values within this builder. Overriding the element values ensures that the default algorithm does not need to determine each of the values. It allows special behaviour that the user may require for XML.
        Parameters:
        name - the name of the XML element to be overridden
        value - the value that is to be used for that element