VOTableUtil
Class Max

java.lang.Object
  |
  +--VOTableUtil.Max

All Implemented Interfaces:

java.io.Serializable, com.tbf.xml.Validateable, com.tbf.xml.XmlObject

public class Max

extends java.lang.Object

implements com.tbf.xml.XmlObject, com.tbf.xml.Validateable, java.io.Serializable

Max class.

See Also:

Serialized Form

Inner Class Summary

static class

Max.Inclusive Enumeration types for the Inclusive property.

Field Summary

protected boolean	_defaulted_Inclusive_
protected java.util.Vector	_doc_declared_namespaces_ Storage for namespaces declared in the input document.
protected java.lang.String	_Inclusive
protected static com.tbf.xml.XmlValidator	_Inclusive_validator_
protected static com.tbf.xml.XmlNamespaceManager	_nsm_ The default XmlNamespaceManager for this class.
protected java.lang.String	_PCDATA
protected static com.tbf.xml.XmlStringValidator	_PCDATA_validator_
protected java.util.Vector	_unexpected_xml_errors_ Storage for UNEXPECTED_XML errors.
protected static boolean	_validators_created This flag is used to used to check whether the validators have been created.
protected java.lang.String	_Value Declarations for the XML related fields.
protected static com.tbf.xml.XmlStringValidator	_Value_validator_
static java.lang.String	$INCLUSIVE Constant for "inclusive" node name.
static java.lang.String	$MAX Constant for "MAX" node name.
static java.lang.String	$VALUE Constant for "value" node name.

Constructor Summary

Max()
Default no args constructor.

Max(com.tbf.xml.XmlElement xml)
Creates and populates an instance from the provided parse tree.

Max(com.tbf.xml.XmlElement xml, com.tbf.xml.XmlObject parent)
Creates and populates an instance from the provided parse tree.

Method Summary

protected static void	createValidators() Create the validators for this class.
boolean	defaultedInclusive() Checks whether the Inclusive property value is the default value.
void	deleteInclusive() Discards Inclusive's value.
void	deletePCDATA() Discards PCDATA's value.
void	deleteValue() Discards Value's value.
void	fromXml(com.tbf.xml.XmlElement xml) Deprecated. will be removed in a future release. Use unmarshal(XmlElement).
java.util.Vector	get$DocumentNamespaces() Get the Vector holding the namespaces declared in the element that this instance was unmarshalled from.
com.tbf.xml.XmlNamespaceManager	get$NamespaceManager() Get the XmlNamespaceManager for this class.
com.tbf.xml.XmlObject	get$Parent() Get this object's parent object.
static java.lang.String	getClassXmlTagName() Gets the XML tag name for this class.
java.lang.String	getInclusive() Get the Inclusive property.
java.lang.String	getPCDATA() Get the PCDATA property.
java.util.Vector	getValidationErrors() Checks each field on the object for validity and returns a Vector holding the validation errors.
java.util.Vector	getValidationErrors(boolean return_on_error) Checks each field on the object for validity and returns a Vector holding the validation errors.
java.util.Vector	getValidationErrors(boolean return_on_error, boolean traverse) Checks each field on the object for validity and returns a Vector holding the validation errors.
java.lang.String	getValue() Get the Value property.
java.lang.String	getXmlTagName() Gets the XML tag name for this object.
boolean	hasInclusive() Checks for whether Inclusive is set or not.
boolean	hasPCDATA() Checks for whether PCDATA is set or not.
boolean	hasValue() Checks for whether Value is set or not.
boolean	isValid() Checks this object to see if it will produce valid XML.
void	marshal(java.io.OutputStream stream) Writes this instance to a stream.
void	marshal(com.tbf.xml.XmlOutputStream out) Writes this instance to an XmlOutputStream.
protected com.tbf.xml.XmlAttributeList	marshalAttributes(com.tbf.xml.XmlAttributeList attrs) Get the XmlAttributeList for marshalling.
static boolean	matches(com.tbf.xml.XmlElement xml, com.tbf.xml.XmlObject parent) Checks the XML to see whether it matches the XML contents of this class.
void	set$Parent(com.tbf.xml.XmlObject parent) Set this object's parent object.
void	setInclusive(com.tbf.util.EnumType new_value)
void	setInclusive(java.lang.String enumValue) Set the Inclusive property.
void	setPCDATA(java.lang.String newValue) Set the PCDATA property.
void	setValue(java.lang.String newValue) Set the Value property.
void	toXml(java.io.OutputStream stream) Deprecated. This method will be removed in a future release. Use marshal(XmlOutputStream) or marshal(OutputStream).
void	toXml(java.io.OutputStream stream, boolean embed_files) Deprecated. This method will be removed in a future release. Use marshal(XmlOutputStream) or marshal(OutputStream).
void	toXml(java.io.OutputStream stream, java.lang.String indent, boolean embed_files) Deprecated. This method will be removed in a future release. Use marshal(XmlOutputStream) or marshal(OutputStream).
static Max	unmarshal(java.io.InputStream in) This method unmarshals an XML document instance into an instance of this class.
void	unmarshal(com.tbf.xml.XmlElement xml) Populates this object with the values from the parsed XML.
protected void	unmarshalAttributes(com.tbf.xml.XmlElement xml) Unmarshal any attributes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

$INCLUSIVE

public static final java.lang.String $INCLUSIVE

Constant for "inclusive" node name.

$VALUE

public static final java.lang.String $VALUE

Constant for "value" node name.

$MAX

public static final java.lang.String $MAX

Constant for "MAX" node name.

_Value

protected java.lang.String _Value

Declarations for the XML related fields.

_Inclusive

protected java.lang.String _Inclusive

_defaulted_Inclusive_

protected boolean _defaulted_Inclusive_

_PCDATA

protected java.lang.String _PCDATA

_unexpected_xml_errors_

protected transient java.util.Vector _unexpected_xml_errors_

Storage for UNEXPECTED_XML errors.

_validators_created

protected static transient boolean _validators_created

This flag is used to used to check whether the validators have been created.

_Value_validator_

protected static transient com.tbf.xml.XmlStringValidator _Value_validator_

_Inclusive_validator_

protected static transient com.tbf.xml.XmlValidator _Inclusive_validator_

_PCDATA_validator_

protected static transient com.tbf.xml.XmlStringValidator _PCDATA_validator_

_nsm_

protected static com.tbf.xml.XmlNamespaceManager _nsm_

The default XmlNamespaceManager for this class.

Since:

2.5

_doc_declared_namespaces_

protected java.util.Vector _doc_declared_namespaces_

Storage for namespaces declared in the input document.

Since:

2.5

Constructor Detail

Max

public Max()

Default no args constructor.

Max

public Max(com.tbf.xml.XmlElement xml)

Creates and populates an instance from the provided parse tree.

Parameters:

xml - the parse tree

Max

public Max(com.tbf.xml.XmlElement xml,
           com.tbf.xml.XmlObject parent)

Creates and populates an instance from the provided parse tree.

Parameters:

xml - the parse tree

parent - the containibg XmlObject

Method Detail

getValue

public java.lang.String getValue()

Get the Value property.

setValue

public void setValue(java.lang.String newValue)

Set the Value property.

hasValue

public boolean hasValue()

Checks for whether Value is set or not.

Returns:

true if Value is set, false if not

deleteValue

public void deleteValue()

Discards Value's value.

getInclusive

public java.lang.String getInclusive()

Get the Inclusive property.

setInclusive

public void setInclusive(java.lang.String enumValue)

Set the Inclusive property.

setInclusive

public void setInclusive(com.tbf.util.EnumType new_value)

hasInclusive

public boolean hasInclusive()

Checks for whether Inclusive is set or not.

Returns:

true if Inclusive is set, false if not

deleteInclusive

public void deleteInclusive()

Discards Inclusive's value.

defaultedInclusive

public boolean defaultedInclusive()

Checks whether the Inclusive property value is the default value.

Returns:

true if Inclusive is defaulted, false if not

getPCDATA

public java.lang.String getPCDATA()

Get the PCDATA property.

setPCDATA

public void setPCDATA(java.lang.String newValue)

Set the PCDATA property.

hasPCDATA

public boolean hasPCDATA()

Checks for whether PCDATA is set or not.

Returns:

true if PCDATA is set, false if not

deletePCDATA

public void deletePCDATA()

Discards PCDATA's value.

getXmlTagName

public java.lang.String getXmlTagName()

Gets the XML tag name for this object.

Specified by:

getXmlTagName in interface com.tbf.xml.XmlObject

getClassXmlTagName

public static java.lang.String getClassXmlTagName()

Gets the XML tag name for this class.

createValidators

protected static void createValidators()

Create the validators for this class.

isValid

public boolean isValid()

Checks this object to see if it will produce valid XML.

Specified by:

isValid in interface com.tbf.xml.XmlObject

getValidationErrors

public java.util.Vector getValidationErrors()

Checks each field on the object for validity and returns a Vector holding the validation errors.

Specified by:

getValidationErrors in interface com.tbf.xml.Validateable

getValidationErrors

public java.util.Vector getValidationErrors(boolean return_on_error)

Checks each field on the object for validity and returns a Vector holding the validation errors.

Specified by:

getValidationErrors in interface com.tbf.xml.Validateable

Returns:

a Vector containing the validation errors

getValidationErrors

public java.util.Vector getValidationErrors(boolean return_on_error,
                                            boolean traverse)

Checks each field on the object for validity and returns a Vector holding the validation errors.

Specified by:

getValidationErrors in interface com.tbf.xml.Validateable

Returns:

a Vector containing the validation errors

matches

public static boolean matches(com.tbf.xml.XmlElement xml,
                              com.tbf.xml.XmlObject parent)

Checks the XML to see whether it matches the XML contents of this class.

unmarshal

public static Max unmarshal(java.io.InputStream in)
                     throws java.lang.Exception

This method unmarshals an XML document instance into an instance of this class.

fromXml

public void fromXml(com.tbf.xml.XmlElement xml)

Deprecated. will be removed in a future release. Use unmarshal(XmlElement).

Populates this object with the values from the parsed XML.

Specified by:

fromXml in interface com.tbf.xml.XmlObject

unmarshal

public void unmarshal(com.tbf.xml.XmlElement xml)

Populates this object with the values from the parsed XML.

Specified by:

unmarshal in interface com.tbf.xml.XmlObject

Since:

2.5

unmarshalAttributes

protected void unmarshalAttributes(com.tbf.xml.XmlElement xml)

Unmarshal any attributes.

Parameters:

xml - the XmlElement holding the parsed XML

Since:

2.5

toXml

public void toXml(java.io.OutputStream stream)

Deprecated. This method will be removed in a future release. Use marshal(XmlOutputStream) or marshal(OutputStream).

Writes this instance to a stream.

Specified by:

toXml in interface com.tbf.xml.XmlObject

Parameters:

stream - the OutputStream to write the XML object to

toXml

public void toXml(java.io.OutputStream stream,
                  boolean embed_files)

Deprecated. This method will be removed in a future release. Use marshal(XmlOutputStream) or marshal(OutputStream).

Writes this instance to a stream.

Specified by:

toXml in interface com.tbf.xml.XmlObject

Parameters:

stream - the OutputStream to write the XML object to

embed_files - set to true to embed files in the XML

toXml

public void toXml(java.io.OutputStream stream,
                  java.lang.String indent,
                  boolean embed_files)

Deprecated. This method will be removed in a future release. Use marshal(XmlOutputStream) or marshal(OutputStream).

Writes this instance to a stream.

Specified by:

toXml in interface com.tbf.xml.XmlObject

Parameters:

stream - the OutputStream to write the XML object to

embed_files - set to true to embed files in the XML

marshal

public void marshal(java.io.OutputStream stream)

Writes this instance to a stream. If the OutputStream is not an instance of XmlOutputStream then a FormattedOutputStream will be created which wraps the OutputStream.

Specified by:

marshal in interface com.tbf.xml.XmlObject

Parameters:

stream - the OutputStream to write the XML object to

Since:

2.5

See Also:

marshal(XmlOutputStream)

marshal

public void marshal(com.tbf.xml.XmlOutputStream out)

Writes this instance to an XmlOutputStream.

Specified by:

marshal in interface com.tbf.xml.XmlObject

Parameters:

out - the XmlOutputStream to write the XML object to

Since:

2.5

See Also:

marshal(OutputStream)

marshalAttributes

protected com.tbf.xml.XmlAttributeList marshalAttributes(com.tbf.xml.XmlAttributeList attrs)

Get the XmlAttributeList for marshalling.

Parameters:

attrs - the currently populated XmlAttributeList.

Returns:

a populated XmlAttributeList

Since:

2.5

get$Parent

public com.tbf.xml.XmlObject get$Parent()

Get this object's parent object.

Specified by:

get$Parent in interface com.tbf.xml.XmlObject

set$Parent

public void set$Parent(com.tbf.xml.XmlObject parent)

Set this object's parent object.

Specified by:

set$Parent in interface com.tbf.xml.XmlObject

get$NamespaceManager

public com.tbf.xml.XmlNamespaceManager get$NamespaceManager()

Get the XmlNamespaceManager for this class. This will be null if no namespaces on this class or if namespace support is disabled during code generation.

Specified by:

get$NamespaceManager in interface com.tbf.xml.XmlObject

Since:

2.5

get$DocumentNamespaces

public java.util.Vector get$DocumentNamespaces()

Get the Vector holding the namespaces declared in the element that this instance was unmarshalled from.

Since:

2.5