com.sap.cloud.sdk.s4hana.serialization

Class SapClient

java.lang.Object

com.sap.cloud.sdk.s4hana.serialization.StringBasedErpType<SapClient>

com.sap.cloud.sdk.s4hana.serialization.SapClient

All Implemented Interfaces:

ErpType<SapClient>, StringRepresentableKey, Serializable, Comparable<SapClient>

public class SapClient
extends StringBasedErpType<SapClient>

Representation of a SAP client (MANDT).

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.sap.cloud.sdk.s4hana.serialization.StringBasedErpType

StringBasedErpType.CharCasing, StringBasedErpType.FillCharStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static SapClient	DEFAULT Placeholder to indicate that the default SapClient should be used when connecting to the ERP.
static SapClient	EMPTY Represents a SapClient with an empty value.

Constructor Summary

Constructors

Constructor and Description
SapClient(String value) Creates a new SapClient representing the given ERP String.

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
StringBasedErpType.FillCharStrategy	getFillCharStrategy()
int	getMaxLength()
Class<SapClient>	getType()
ErpTypeConverter<SapClient>	getTypeConverter() Get the type converter for the ERP type.
int	hashCode()
static SapClient	of(String value) Creates a new SapClient based on the given String value.
static Set<SapClient>	toSapClients(Collection<String> values) Transforms the given collection of Strings representing SapClients to a set of SapClients via the SapClientConverter.
static Set<String>	toStrings(Collection<SapClient> values) Transforms the given collection of SapClients to a set of Strings representing those SapClients via the SapClientConverter.

Methods inherited from class com.sap.cloud.sdk.s4hana.serialization.StringBasedErpType

compareTo, getFillChar, getKeyAsString, getValue, isDefault, isEmpty, toString, toString, transformToString, transformToType

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final SapClient DEFAULT

Placeholder to indicate that the default SapClient should be used when connecting to the ERP.

Note: This value does not contain the actual value of the ERP's SapClient, it just logically represents the unknown default value that the respective ERP uses.

EMPTY

public static final SapClient EMPTY

Represents a SapClient with an empty value. How this is value is interpreted depends on the respective business scenario.

Important: While this value currently corresponds to DEFAULT, this equivalence must not be taken for granted and may change in the future.

Constructor Detail

SapClient

public SapClient(@Nonnull
                 String value)
          throws IllegalArgumentException

Creates a new SapClient representing the given ERP String.

Parameters:

value - The String value to represent.

Throws:

IllegalArgumentException - If value is null or the length of value is longer than the length specified by getMaxLength().

Method Detail

of

@Nullable
public static SapClient of(@Nullable
                                     String value)
                              throws IllegalArgumentException

Creates a new SapClient based on the given String value.

Parameters:

value - The String value the SapClient should represent.

Returns:

A newly created SapClient, or null, if value is null.

Throws:

IllegalArgumentException - If the length of value is longer than the length specified by getMaxLength().

getTypeConverter

@Nonnull
public ErpTypeConverter<SapClient> getTypeConverter()

Description copied from interface: ErpType

Get the type converter for the ERP type.

Returns:

The type converter.

getType

@Nonnull
public Class<SapClient> getType()

Specified by:

getType in class StringBasedErpType<SapClient>

Returns:

The class of the string-based ERP type.

getMaxLength

public int getMaxLength()

Specified by:

getMaxLength in class StringBasedErpType<SapClient>

Returns:

The maximum length of the string-based ERP type.

getFillCharStrategy

@Nonnull
public StringBasedErpType.FillCharStrategy getFillCharStrategy()

Specified by:

getFillCharStrategy in class StringBasedErpType<SapClient>

Returns:

The strategy of how the type should handle fill characters.

toSapClients

@Nonnull
public static Set<SapClient> toSapClients(Collection<String> values)

Transforms the given collection of Strings representing SapClients to a set of SapClients via the SapClientConverter.

Parameters:

values - The collection of strings to convert.

Returns:

The set of SapClients.

toStrings

@Nonnull
public static Set<String> toStrings(Collection<SapClient> values)

Transforms the given collection of SapClients to a set of Strings representing those SapClients via the SapClientConverter.

Parameters:

values - The collection of SapClients to convert.

Returns:

The set of Strings.

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class StringBasedErpType<SapClient>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class StringBasedErpType<SapClient>

hashCode

public int hashCode()

Overrides:

hashCode in class StringBasedErpType<SapClient>