edu.mit.jverbnet.data.semantics
Enum ArgTypeEvent

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

public enum ArgTypeEvent
extends java.lang.Enum<ArgTypeEvent>
implements ISemanticArgType

The subtypes of event argument type. The values in this enum correspond to the elements of <xsd:simpleType name="argEventType"> in the Verbnet xsd file.

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

Enum Constant Summary
duringE
           
duringE0
           
duringE1
           
E
           
E0
           
E1
           
endE
           
endE0
           
endE1
           
resultE
           
resultE0
           
resultE1
           
startE
           
startE0
           
startE1
           
 
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
 ArgType getArgType()
          Returns the argument type of which this type is the subtype.
static ArgTypeEvent 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.String toString()
           
static ArgTypeEvent valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ArgTypeEvent[] 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, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

E

public static final ArgTypeEvent E

E0

public static final ArgTypeEvent E0

E1

public static final ArgTypeEvent E1

duringE

public static final ArgTypeEvent duringE

duringE0

public static final ArgTypeEvent duringE0

duringE1

public static final ArgTypeEvent duringE1

endE

public static final ArgTypeEvent endE

endE0

public static final ArgTypeEvent endE0

endE1

public static final ArgTypeEvent endE1

resultE

public static final ArgTypeEvent resultE

resultE0

public static final ArgTypeEvent resultE0

resultE1

public static final ArgTypeEvent resultE1

startE

public static final ArgTypeEvent startE

startE0

public static final ArgTypeEvent startE0

startE1

public static final ArgTypeEvent startE1
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 ArgTypeEvent[] 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 (ArgTypeEvent c : ArgTypeEvent.values())
    System.out.println(c);

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

valueOf

public static ArgTypeEvent 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

getArgType

public ArgType getArgType()
Description copied from interface: ISemanticArgType
Returns the argument type of which this type is the subtype. Never null.

Specified by:
getArgType in interface ISemanticArgType
Returns:
the non-null argument type of which this type is a specialization

getById

public static ArgTypeEvent 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

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Enum<ArgTypeEvent>


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