Package com.azure.core.util

Class ExpandableStringEnum<T extends ExpandableStringEnum<T>>

java.lang.Object

com.azure.core.util.ExpandableStringEnum<T>

Type Parameters:

T - a specific expandable enum type

All Implemented Interfaces:

ExpandableEnum<String>

Direct Known Subclasses:

AzureCloud, CloudEventDataFormat, GeoObjectType, HttpHeaderName, LongRunningOperationStatus

public abstract class ExpandableStringEnum<T extends ExpandableStringEnum<T>>
extends Object
implements ExpandableEnum<String>

Base implementation for expandable, single string enums.

Constructor Summary

Constructors

Constructor	Description
ExpandableStringEnum()	Deprecated. Use the fromString(String, Class) factory method.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
protected static <T extends ExpandableStringEnum<T>> T	fromString(String name, Class<T> clazz)	Creates an instance of the specific expandable string enum from a String.
String	getValue()	Returns the value represented by this expandable enum instance.
int	hashCode()
String	toString()
protected static <T extends ExpandableStringEnum<T>> Collection<T>	values(Class<T> clazz)	Gets a collection of all known values to an expandable string enum type.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ExpandableStringEnum

@Deprecated
public ExpandableStringEnum()

Deprecated.

Use the fromString(String, Class) factory method.

Creates a new instance of ExpandableStringEnum without a toString() value.

This constructor shouldn't be called as it will produce a ExpandableStringEnum which doesn't have a String enum value.

Method Details

fromString

protected static <T extends ExpandableStringEnum<T>>
T fromString(String name,
 Class<T> clazz)

Creates an instance of the specific expandable string enum from a String.

Type Parameters:

T - the class of the expandable string enum.

Parameters:

name - The value to create the instance from.

clazz - The class of the expandable string enum.

Returns:

The expandable string enum instance.

Throws:

RuntimeException - wrapping implementation class constructor exception (if any is thrown).

values

protected static <T extends ExpandableStringEnum<T>>
Collection<T> values(Class<T> clazz)

Gets a collection of all known values to an expandable string enum type.

Type Parameters:

T - the class of the expandable string enum.

Parameters:

clazz - the class of the expandable string enum.

Returns:

A collection of all known values for the given clazz.

toString

public String toString()

Overrides:

toString in class Object

getValue

public String getValue()

Description copied from interface: ExpandableEnum

Returns the value represented by this expandable enum instance.

Specified by:

getValue in interface ExpandableEnum<T extends ExpandableStringEnum<T>>

Returns:

The value represented by this expandable enum instance.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object