Package software.amazon.awssdk.services.amplifyuibuilder.model

Class FieldPosition

java.lang.Object

software.amazon.awssdk.services.amplifyuibuilder.model.FieldPosition

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FieldPosition.Builder,FieldPosition>

@Generated("software.amazon.awssdk:codegen")
public final class FieldPosition
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FieldPosition.Builder,FieldPosition>

Describes the field position.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FieldPosition.Builder
static class	FieldPosition.Type

Method Summary

Modifier and Type	Method	Description
String	below()	The field position is below the field specified by the string.
static FieldPosition.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FixedPosition	fixed()	The field position is fixed and doesn't change in relation to other fields.
String	fixedAsString()	The field position is fixed and doesn't change in relation to other fields.
static FieldPosition	fromBelow(String below)	Create an instance of this class with below() initialized to the given value.
static FieldPosition	fromFixed(String fixed)	Create an instance of this class with fixedAsString() initialized to the given value.
static FieldPosition	fromFixed(FixedPosition fixed)	Create an instance of this class with fixedAsString() initialized to the given value.
static FieldPosition	fromRightOf(String rightOf)	Create an instance of this class with rightOf() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	rightOf()	The field position is to the right of the field specified by the string.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends FieldPosition.Builder>	serializableBuilderClass()
FieldPosition.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
FieldPosition.Type	type()	Retrieve an enum value representing which member of this object is populated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

fixed

public final FixedPosition fixed()

The field position is fixed and doesn't change in relation to other fields.

If the service returns an enum value that is not available in the current SDK version, fixed will return FixedPosition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fixedAsString().

Returns:

The field position is fixed and doesn't change in relation to other fields.

See Also:

FixedPosition

fixedAsString

public final String fixedAsString()

The field position is fixed and doesn't change in relation to other fields.

If the service returns an enum value that is not available in the current SDK version, fixed will return FixedPosition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fixedAsString().

Returns:

The field position is fixed and doesn't change in relation to other fields.

See Also:

FixedPosition

rightOf

public final String rightOf()

The field position is to the right of the field specified by the string.

Returns:

The field position is to the right of the field specified by the string.

below

public final String below()

The field position is below the field specified by the string.

Returns:

The field position is below the field specified by the string.

toBuilder

public FieldPosition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FieldPosition.Builder,FieldPosition>

builder

public static FieldPosition.Builder builder()

serializableBuilderClass

public static Class<? extends FieldPosition.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

fromFixed

public static FieldPosition fromFixed(String fixed)

Create an instance of this class with fixedAsString() initialized to the given value.

The field position is fixed and doesn't change in relation to other fields.

Parameters:

fixed - The field position is fixed and doesn't change in relation to other fields.

See Also:

FixedPosition

fromFixed

public static FieldPosition fromFixed(FixedPosition fixed)

Create an instance of this class with fixedAsString() initialized to the given value.

The field position is fixed and doesn't change in relation to other fields.

Parameters:

fixed - The field position is fixed and doesn't change in relation to other fields.

See Also:

FixedPosition

fromRightOf

public static FieldPosition fromRightOf(String rightOf)

Create an instance of this class with rightOf() initialized to the given value.

The field position is to the right of the field specified by the string.

Parameters:

rightOf - The field position is to the right of the field specified by the string.

fromBelow

public static FieldPosition fromBelow(String below)

Create an instance of this class with below() initialized to the given value.

The field position is below the field specified by the string.

Parameters:

below - The field position is below the field specified by the string.

type

public FieldPosition.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be FieldPosition.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be FieldPosition.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo