org.eclipse.birt.chart.model.attribute
Enum SortOption

java.lang.Object
  extended by java.lang.Enum<SortOption>
      extended by org.eclipse.birt.chart.model.attribute.SortOption
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<SortOption>, org.eclipse.emf.common.util.Enumerator

public enum SortOption
extends java.lang.Enum<SortOption>
implements org.eclipse.emf.common.util.Enumerator

A representation of the literals of the enumeration ' Sort Option', and utility methods for working with them. This type represents the options available for sorting.

See Also:
AttributePackage.getSortOption()

Enum Constant Summary
ASCENDING_LITERAL
          The 'Ascending' literal object.
DESCENDING_LITERAL
          The 'Descending' literal object.
 
Field Summary
static int ASCENDING
          The 'Ascending' literal value.
static int DESCENDING
          The 'Descending' literal value.
static java.util.List<SortOption> VALUES
          A public read-only list of all the 'Sort Option' enumerators.
 
Method Summary
static SortOption get(int value)
          Returns the 'Sort Option' literal with the specified integer value.
static SortOption get(java.lang.String literal)
          Returns the 'Sort Option' literal with the specified literal value.
static SortOption getByName(java.lang.String name)
          Returns the 'Sort Option' literal with the specified name.
 java.lang.String getLiteral()
           
 java.lang.String getName()
           
 int getValue()
           
 java.lang.String toString()
          Returns the literal value of the enumerator, which is its string representation.
static SortOption valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static SortOption[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ASCENDING_LITERAL

public static final SortOption ASCENDING_LITERAL
The 'Ascending' literal object.

If the meaning of 'Ascending' literal object isn't clear, there really should be more of a description here...

See Also:
ASCENDING

DESCENDING_LITERAL

public static final SortOption DESCENDING_LITERAL
The 'Descending' literal object.

If the meaning of 'Descending' literal object isn't clear, there really should be more of a description here...

See Also:
DESCENDING
Field Detail

ASCENDING

public static final int ASCENDING
The 'Ascending' literal value.

See Also:
ASCENDING_LITERAL, Constant Field Values

DESCENDING

public static final int DESCENDING
The 'Descending' literal value.

See Also:
DESCENDING_LITERAL, Constant Field Values

VALUES

public static final java.util.List<SortOption> VALUES
A public read-only list of all the 'Sort Option' enumerators.

Method Detail

values

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

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

valueOf

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

get

public static SortOption get(java.lang.String literal)
Returns the 'Sort Option' literal with the specified literal value.


getByName

public static SortOption getByName(java.lang.String name)
Returns the 'Sort Option' literal with the specified name.


get

public static SortOption get(int value)
Returns the 'Sort Option' literal with the specified integer value.


getValue

public int getValue()

Specified by:
getValue in interface org.eclipse.emf.common.util.Enumerator

getName

public java.lang.String getName()

Specified by:
getName in interface org.eclipse.emf.common.util.Enumerator

getLiteral

public java.lang.String getLiteral()

Specified by:
getLiteral in interface org.eclipse.emf.common.util.Enumerator

toString

public java.lang.String toString()
Returns the literal value of the enumerator, which is its string representation.

Overrides:
toString in class java.lang.Enum<SortOption>


Copyright © 2005-2008 Actuate Corp. All rights reserved.