edu.mit.jverbnet.data.semantics
Enum ArgType

java.lang.Object
  extended by java.lang.Enum<ArgType>
      extended by edu.mit.jverbnet.data.semantics.ArgType
All Implemented Interfaces:
IVerbnetType, IHasID, java.io.Serializable, java.lang.Comparable<ArgType>

public enum ArgType
extends java.lang.Enum<ArgType>
implements IVerbnetType

Argument types. The values in this enum correspond to the elements of <xsd:simpleType name="argType"> in the Verbnet xsd file.

Since:
JVerbnet 1.0.0
Version:
1.2.0
Author:
Mark A. Finlayson

Enum Constant Summary
Constant
           
Event
           
ThemRole
           
VerbSpecific
           
 
Field Summary
static java.lang.String XSD_TYPE_NAME
          The name of the xsd:simpleType entry that describes this verbnet type in the XSD file.
 
Fields inherited from interface edu.mit.jverbnet.data.IVerbnetType
FIELD_NAME_XSD_TYPE_NAME, METHOD_NAME_getById
 
Method Summary
static ArgType getById(java.lang.String id)
          Returns the object corresponding to the specified xsd name.
 java.lang.String getID()
          Returns the id of the type, as defined in the xsd file.
 java.lang.Class<? extends ISemanticArgType> getSubclassType()
          Returns the associated subclass type for this argument type.
static ArgType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ArgType[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

Constant

public static final ArgType Constant

Event

public static final ArgType Event

ThemRole

public static final ArgType ThemRole

VerbSpecific

public static final ArgType VerbSpecific
Field Detail

XSD_TYPE_NAME

public static final java.lang.String XSD_TYPE_NAME
The name of the xsd:simpleType entry that describes this verbnet type in the XSD file.

Since:
JVerbnet 1.0.0
See Also:
Constant Field Values
Method Detail

values

public static ArgType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (ArgType c : ArgType.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static ArgType valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

getID

public java.lang.String getID()
Description copied from interface: IHasID
Returns the id of the type, as defined in the xsd file. Will never be null or empty.

Specified by:
getID in interface IHasID
Returns:
the id of the type

getSubclassType

public java.lang.Class<? extends ISemanticArgType> getSubclassType()
Returns the associated subclass type for this argument type.

Returns:
the associated subclass type for this argument type
Since:
JVerbnet 1.0.0

getById

public static ArgType getById(java.lang.String id)
Returns the object corresponding to the specified xsd name. The id is matched to values without regard to case. If no value has the specified id, the method returns null. If the VerbnetTypes.isPrintingIdWarnings() flag is set, the method will print a warning to standard out if there is no value with the specified id, or if the specified id is not exactly identical to the value's id (i.e., differs in case).

Parameters:
id - the id of the type value as found in the xsd file and in the xml data files.
Returns:
the type corresponding to the specified xsd name, or null if none
Throws:
java.lang.NullPointerException - if the id is null
java.lang.IllegalArgumentException - if the id is empty or all whitespace
Since:
JVerbnet 1.0.0


Copyright © 2012 ${project.organization.name}. All Rights Reserved.