org.exolab.castor.xml.schema
Class Form

java.lang.Object
  org.exolab.castor.xml.schema.Form

public class Form
extends Object

Represents an enumerated type which consists of two values: "qualified" and "unqualified". This is used for the "form" property on attribute and element defintions as well as the attributeFormDefault and elementFormDefault proprties on the Schema itself.

Version:

$Revision: 5951 $ $Date: 2003-03-03 00:05:44 -0700 (Mon, 03 Mar 2003) $

Author:

Keith Visco

Field Summary

static Form	Qualified The Qualified Form Object
static String	QUALIFIED_VALUE The String value for the qualified Form
static Form	Unqualified The Qualified Form Object
static String	UNQUALIFIED_VALUE The String value for the unqualified Form

Method Summary

String	getValue() Returns the String value of this Form.
boolean	isQualified() Returns true if this Form is the qualified Form.
boolean	isUnqualified() Returns true if this Form is the unqualified Form.
String	toString() Returns the String value of this Form.
static Form	valueOf(String formValue) Returns the Form corresponding to the given value.

Methods inherited from class java.lang.Object

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

Field Detail

QUALIFIED_VALUE

public static final String QUALIFIED_VALUE

The String value for the qualified Form

See Also:

Constant Field Values

UNQUALIFIED_VALUE

public static final String UNQUALIFIED_VALUE

The String value for the unqualified Form

See Also:

Constant Field Values

Qualified

public static final Form Qualified

The Qualified Form Object

Unqualified

public static final Form Unqualified

The Qualified Form Object

Method Detail

getValue

public String getValue()

Returns the String value of this Form.

Returns:

the String value of this Form.

isQualified

public boolean isQualified()

Returns true if this Form is the qualified Form.

Returns:

true if this Form is the qualified Form.

isUnqualified

public boolean isUnqualified()

Returns true if this Form is the unqualified Form.

Returns:

true if this Form is the unqualified Form.

toString

public String toString()

Returns the String value of this Form.

Overrides:

toString in class Object

Returns:

the String value of this Form.

valueOf

public static Form valueOf(String formValue)

Returns the Form corresponding to the given value.

Parameters:

formValue - the value of the Form to return.

Returns:

the Form corresponding to the given value.

Throws:

IllegalArgumentException - when the given value is not valid.