Class XSClass

java.lang.Object
org.exolab.castor.builder.types.XSType
org.exolab.castor.builder.types.XSClass

public final class XSClass extends XSType
The XML Schema user-defined archetype.
Version:
$Revision: 6907 $ $Date: 2003-03-03 00:05:44 -0700 (Mon, 03 Mar 2003) $
Author:
Keith Visco, Ralf Joachim
  • Field Details

  • Constructor Details

    • XSClass

      public XSClass(JClass jClass)
      Creates a new XSClass with the given JClass reference.
      Parameters:
      jClass - The JClass type of this XSClass.
    • XSClass

      public XSClass(JClass jClass, String schemaTypeName)
      Creates a new XSClass with the given JClass reference.
      Parameters:
      jClass - The JClass associated with this XSType.
      schemaTypeName - The XML Schema type name.
  • Method Details

    • getName

      public String getName()
      Returns the name of this XSType.
      Specified by:
      getName in class XSType
      Returns:
      The name of this XSType.
    • getType

      public short getType()
      Returns the type of this XSType.
      Specified by:
      getType in class XSType
      Returns:
      the type of this XSType.
    • isPrimitive

      public boolean isPrimitive()
      Returns true if this XSType represents a primitive type.
      Specified by:
      isPrimitive in class XSType
      Returns:
      True if this XSType represents a primitive type.
    • isDateTime

      public boolean isDateTime()
      Returns true if the XSType represents an XML Schema date/time type.
      Specified by:
      isDateTime in class XSType
      Returns:
      True if the XSType represents an XML Schema date/time type.
    • getJType

      public JType getJType()
      Returns the JType that this XSType represents.
      Specified by:
      getJType in class XSType
      Returns:
      The JType that this XSType represents.
    • newInstanceCode

      public String newInstanceCode()
      Returns the Java code neccessary to create a new instance of the JType associated with this XSType.
      Specified by:
      newInstanceCode in class XSType
      Returns:
      The Java code neccessary to create a new instance.
    • createToJavaObjectCode

      public String createToJavaObjectCode(String variableName)
      Returns the string necessary to convert an instance of this XSType to an Object. This method is really only useful for primitive types.
      Specified by:
      createToJavaObjectCode in class XSType
      Parameters:
      variableName - The name of the instance variable.
      Returns:
      The String necessary to convert an instance of this XSType to an Object.
    • createFromJavaObjectCode

      public String createFromJavaObjectCode(String variableName)
      Returns the string necessary to convert an Object to an instance of this XSType. This method is really only useful for primitive types.
      Specified by:
      createFromJavaObjectCode in class XSType
      Parameters:
      variableName - The name of the Object.
      Returns:
      The String necessary to convert an Object to an instance of this XSType.
    • setFacet

      protected void setFacet(Facet facet)
      Set the given facet for XSType if applicable.
      Specified by:
      setFacet in class XSType
      Parameters:
      facet - The facet to set for XSType.
    • validationCode

      public void validationCode(JSourceCode jsc, String fixedValue, String validatorInstanceName)
      Creates the validation code for an instance of this XSType. If necessary the validation code should create a newly configured TypeValidator, that should then be added to a FieldValidator instance whose name is provided.
      Specified by:
      validationCode in class XSType
      Parameters:
      jsc - The JSourceCode to fill in.
      fixedValue - A fixed value to use if any.
      validatorInstanceName - The name of the FieldValidator that the configured TypeValidator should be added to.