Class FieldPosition
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<FieldPosition.Builder,
FieldPosition>
Describes the field position.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
static enum
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
below()
The field position is below the field specified by the string.static FieldPosition.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final FixedPosition
fixed()
The field position is fixed and doesn't change in relation to other fields.final String
The field position is fixed and doesn't change in relation to other fields.static FieldPosition
Create an instance of this class withbelow()
initialized to the given value.static FieldPosition
Create an instance of this class withfixedAsString()
initialized to the given value.static FieldPosition
fromFixed
(FixedPosition fixed) Create an instance of this class withfixedAsString()
initialized to the given value.static FieldPosition
fromRightOf
(String rightOf) Create an instance of this class withrightOf()
initialized to the given value.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
rightOf()
The field position is to the right of the field specified by the string.static Class
<? extends FieldPosition.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.type()
Retrieve an enum value representing which member of this object is populated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnFixedPosition.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfixedAsString()
.- Returns:
- The field position is fixed and doesn't change in relation to other fields.
- See Also:
-
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 returnFixedPosition.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfixedAsString()
.- Returns:
- The field position is fixed and doesn't change in relation to other fields.
- See Also:
-
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
The field position is below the field specified by the string.
- Returns:
- The field position is below the field specified by the string.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<FieldPosition.Builder,
FieldPosition> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
fromFixed
Create an instance of this class withfixedAsString()
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:
-
fromFixed
Create an instance of this class withfixedAsString()
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:
-
fromRightOf
Create an instance of this class withrightOf()
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
Create an instance of this class withbelow()
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
Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will beFieldPosition.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 beFieldPosition.Type.UNKNOWN_TO_SDK_VERSION
if zero members are set, andnull
if more than one member is set. -
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-