Enumeration (GroupDocs.Total for Java (24.10) API Reference)

java.lang.Object
- com.groupdocs.conversion.contracts.Enumeration

All Implemented Interfaces:

com.aspose.ms.System.IEquatable<Enumeration>, Serializable, Comparable

Direct Known Subclasses:

CadDrawTypeMode, EmailField, FileType, ImageFlipModes, JpgColorModes, JpgCompressionMethods, PdfDirection, PdfFormats, PdfPageLayout, PdfPageMode, PsdColorModes, PsdCompressionMethods, Rotation, TiffCompressionMethods, TxtLeadingSpacesOptions, TxtTrailingSpacesOptions
```
public abstract class Enumeration
extends Object
implements Comparable, Serializable, com.aspose.ms.System.IEquatable<Enumeration>
```
Generic enumeration class.
TKey:

See Also:

Serialized Form

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Enumeration()` Serialization constructor
`protected`	`Enumeration(String key, String name)` Initializes new instance of Enumeration class.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Object obj)` Compares current object to other.
`boolean`	`equals(Enumeration other)` Determines whether two object instances are equal.
`boolean`	`equals(Object obj)` Determines whether two object instances are equal.
`static <T extends Enumeration> T`	`fromDisplayName(Class<T> typeOfT, String displayName)` Returns object by display name.
`static <T extends Enumeration> T`	`fromValue(Class<T> typeOfT, String value)` Returns object by key.
`static <T extends Enumeration> List`	`getAll(Class<T> typeOfT)` Returns all enumeration values.
`protected String`	`getKey()` The enumeration key.
`protected String`	`getName()` The enumeration name.
`int`	`hashCode()` Serves as the default hash function.
`static boolean`	`op_Equality(Enumeration left, Enumeration right)` Equality operator.
`static boolean`	`op_Inequality(Enumeration left, Enumeration right)` Inequality operator.
`String`	`toString()` Returns a string that represents the current object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Enumeration
```
protected Enumeration()
```
    Serialization constructor
  - Enumeration
```
protected Enumeration(String key,
                      String name)
```
    Initializes new instance of Enumeration class.
    
    Parameters:
    
    key - The enumeration key.
    
    name - The enumeration name.
- Method Detail
  - compareTo
```
public final int compareTo(Object obj)
```
    Compares current object to other.
    
    Specified by:
    
    compareTo in interface Comparable
    
    Parameters:
    
    obj - The other object
    
    Returns:
    
    zero if equal
  - equals
```
public boolean equals(Enumeration other)
```
    Determines whether two object instances are equal.
    
    Parameters:
    
    other - The object to compare with the current object.
    
    Returns:
    
    true if the specified object is equal to the current object; otherwise, false.
  - equals
```
public boolean equals(Object obj)
```
    Determines whether two object instances are equal.
    
    Specified by:
    
    equals in interface com.aspose.ms.System.IEquatable<Enumeration>
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - The object to compare with the current object.
    
    Returns:
    
    true if the specified object is equal to the current object; otherwise, false.
  - fromDisplayName
```
public static <T extends Enumeration> T fromDisplayName(Class<T> typeOfT,
                                                        String displayName)
```
    Returns object by display name.
    
    Parameters:
    
    displayName - The display name
    
    Returns:
    
    The object
  - fromValue
```
public static <T extends Enumeration> T fromValue(Class<T> typeOfT,
                                                  String value)
```
    Returns object by key.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The object
  - getAll
```
public static <T extends Enumeration> List getAll(Class<T> typeOfT)
```
    Returns all enumeration values.
    
    Returns:
    
    Enumerable of the provided type
    T: Enumerated object type.
  - getKey
```
protected final String getKey()
```
    The enumeration key.
  - getName
```
protected final String getName()
```
    The enumeration name.
  - hashCode
```
public int hashCode()
```
    Serves as the default hash function.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    A hash code for the current object.
  - op_Equality
```
public static boolean op_Equality(Enumeration left,
                                  Enumeration right)
```
    Equality operator.
    
    Parameters:
    
    left - The first object
    
    right - The second object
    
    Returns:
    
    true if objects are equal
  - op_Inequality
```
public static boolean op_Inequality(Enumeration left,
                                    Enumeration right)
```
    Inequality operator.
    
    Parameters:
    
    left - The first object
    
    right - The second object
    
    Returns:
    
    true if objects are not equal
  - toString
```
public String toString()
```
    Returns a string that represents the current object.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation

Class Enumeration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Enumeration

Enumeration

Method Detail

compareTo

equals

equals

fromDisplayName

fromValue

getAll

getKey

getName

hashCode

op_Equality

op_Inequality

toString