Class WrapOptions

java.lang.Object
software.amazon.awssdk.services.b2bi.model.WrapOptions
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<WrapOptions.Builder,WrapOptions>
@Generated("software.amazon.awssdk:codegen") public final class WrapOptions extends Object implements SdkPojo, Serializable, ToCopyableBuilder<WrapOptions.Builder,WrapOptions>

Contains options for wrapping (line folding) in X12 EDI files. Wrapping controls how long lines are handled in the EDI output.

See Also:

  • Method Details

    • wrapBy

      public final WrapFormat wrapBy()

      Specifies the method used for wrapping lines in the EDI output. Valid values:

      • SEGMENT: Wraps by segment.

      • ONE_LINE: Indicates that the entire content is on a single line.

        When you specify ONE_LINE, do not provide either the line length nor the line terminator value.

      • LINE_LENGTH: Wraps by character count, as specified by lineLength value.

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

      Returns:
      Specifies the method used for wrapping lines in the EDI output. Valid values:

      • SEGMENT: Wraps by segment.

      • ONE_LINE: Indicates that the entire content is on a single line.

        When you specify ONE_LINE, do not provide either the line length nor the line terminator value.

      • LINE_LENGTH: Wraps by character count, as specified by lineLength value.

      See Also:

    • wrapByAsString

      public final String wrapByAsString()

      Specifies the method used for wrapping lines in the EDI output. Valid values:

      • SEGMENT: Wraps by segment.

      • ONE_LINE: Indicates that the entire content is on a single line.

        When you specify ONE_LINE, do not provide either the line length nor the line terminator value.

      • LINE_LENGTH: Wraps by character count, as specified by lineLength value.

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

      Returns:
      Specifies the method used for wrapping lines in the EDI output. Valid values:

      • SEGMENT: Wraps by segment.

      • ONE_LINE: Indicates that the entire content is on a single line.

        When you specify ONE_LINE, do not provide either the line length nor the line terminator value.

      • LINE_LENGTH: Wraps by character count, as specified by lineLength value.

      See Also:

    • lineTerminator

      public final LineTerminator lineTerminator()

      Specifies the character sequence used to terminate lines when wrapping. Valid values:

      • CRLF: carriage return and line feed

      • LF: line feed)

      • CR: carriage return

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

      Returns:
      Specifies the character sequence used to terminate lines when wrapping. Valid values:

      • CRLF: carriage return and line feed

      • LF: line feed)

      • CR: carriage return

      See Also:

    • lineTerminatorAsString

      public final String lineTerminatorAsString()

      Specifies the character sequence used to terminate lines when wrapping. Valid values:

      • CRLF: carriage return and line feed

      • LF: line feed)

      • CR: carriage return

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

      Returns:
      Specifies the character sequence used to terminate lines when wrapping. Valid values:

      • CRLF: carriage return and line feed

      • LF: line feed)

      • CR: carriage return

      See Also:

    • lineLength

      public final Integer lineLength()

      Specifies the maximum length of a line before wrapping occurs. This value is used when wrapBy is set to LINE_LENGTH.

      Returns:
      Specifies the maximum length of a line before wrapping occurs. This value is used when wrapBy is set to LINE_LENGTH.

    • toBuilder

      public WrapOptions.Builder 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 interface ToCopyableBuilder<WrapOptions.Builder,WrapOptions>
      Returns:
      a builder for type T

    • builder

      public static WrapOptions.Builder builder()

    • serializableBuilderClass

      public static Class<? extends WrapOptions.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.