Package org.tquadrat.foundation.config.ap

Enum Class CollectionKind

java.lang.Object

java.lang.Enum<CollectionKind>

org.tquadrat.foundation.config.ap.CollectionKind

All Implemented Interfaces:

Serializable, Comparable<CollectionKind>, Constable

@ClassVersion(sourceVersion="$Id: CollectionKind.java 1002 2022-02-01 21:33:00Z tquadrat $")
@API(status=INTERNAL,
     since="0.1.0")
public enum CollectionKind
extends Enum<CollectionKind>

The kind of collection for a property type that is a collection.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: CollectionKind.java 1002 2022-02-01 21:33:00Z tquadrat $

Since:

0.1.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.config.ap.CollectionKind"

⁠

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
LIST	The type is a List.
MAP	The type is a Map.
NO_COLLECTION	The type is not a collection at all.
SET	The type is a Set.

Field Summary

Fields

Modifier and Type	Field	Description
private final TypeName	m_AccessorType	The type name for the accessor.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CollectionKind(TypeName accessor)	Creates a new CollectionKind instance.

Method Summary

Modifier and Type	Method	Description
final TypeName	getAccessorType()	Returns the accessor type for the collection kind.
static CollectionKind	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CollectionKind[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LIST

public static final CollectionKind LIST

The type is a List.

MAP

public static final CollectionKind MAP

The type is a Map.

SET

public static final CollectionKind SET

The type is a Set.

NO_COLLECTION

public static final CollectionKind NO_COLLECTION

The type is not a collection at all.

Field Details

m_AccessorType

private final TypeName m_AccessorType

The type name for the accessor.

Constructor Details

CollectionKind

private CollectionKind(TypeName accessor)

Creates a new CollectionKind instance.

Parameters:

accessor - The type name for the accessor.

Method Details

values

public static CollectionKind[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CollectionKind valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getAccessorType

public final TypeName getAccessorType()

Returns the accessor type for the collection kind.

Returns:

The accessor type.