Package org.immutables.encode

Enum Encoding.StandardNaming

java.lang.Object

java.lang.Enum<Encoding.StandardNaming>

org.immutables.encode.Encoding.StandardNaming

All Implemented Interfaces:

Serializable, Comparable<Encoding.StandardNaming>, java.lang.constant.Constable

Enclosing class:

Encoding

public static enum Encoding.StandardNaming
extends Enum<Encoding.StandardNaming>

Standard namings can be used to reuse standard styles, like the ones defined in Value.Immutable.Style for the custom-defined elements in encoding. If Encoding.StandardNaming is used with the generator other than Immutables which do not have notion of namings/styles, then, typical default values will be used.

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
ADD	builder add method, depluralized.
ADD_ALL	builder add all method.
GET	naming of the accessor method.
INIT	builder init method.
NONE	no standard naming is used.
PUT	builder put method, depluralized.
PUT_ALL	builder put all method.
WITH	with copy method.

Field Summary

Fields

Modifier and Type	Field	Description
final boolean	depluralize
final String	pattern

Constructor Summary

Constructors

Modifier	Constructor	Description
private	StandardNaming(String pattern)
private	StandardNaming(String pattern, boolean depluralize)

Method Summary

Modifier and Type	Method	Description
static Encoding.StandardNaming	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Encoding.StandardNaming[]	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, 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

NONE

public static final Encoding.StandardNaming NONE

no standard naming is used.

GET

public static final Encoding.StandardNaming GET

naming of the accessor method. as accessors are detected, this naming would signalize the need to copy current detected accessors naming to some other element.

INIT

public static final Encoding.StandardNaming INIT

builder init method.

WITH

public static final Encoding.StandardNaming WITH

with copy method.

ADD

public static final Encoding.StandardNaming ADD

builder add method, depluralized.

ADD_ALL

public static final Encoding.StandardNaming ADD_ALL

builder add all method.

PUT

public static final Encoding.StandardNaming PUT

builder put method, depluralized.

PUT_ALL

public static final Encoding.StandardNaming PUT_ALL

builder put all method.

Field Details

pattern

public final String pattern

depluralize

public final boolean depluralize

Constructor Details

StandardNaming

private StandardNaming(String pattern)

StandardNaming

private StandardNaming(String pattern,
 boolean depluralize)

Method Details

values

public static Encoding.StandardNaming[] values()

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

Returns:

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

valueOf

public static Encoding.StandardNaming valueOf(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:

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

NullPointerException - if the argument is null