Package com.oracle.bmc.datasafe.model

Class SubstringFormatEntry

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.datasafe.model.FormatEntry

com.oracle.bmc.datasafe.model.SubstringFormatEntry

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public final class SubstringFormatEntry
extends FormatEntry

The Substring masking format extracts a portion of the original column value and uses it to replace the original value.

It internally uses the Oracle SUBSTR function. It takes the start position and length as input, extracts substring from the original value using SUBSTR, and uses the substring to replace the original value. To learn more, check Substring in the Data Safe documentation.
Note: Objects should always be created or deserialized using the SubstringFormatEntry.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the SubstringFormatEntry.Builder, which maintain a set of all explicitly set fields called SubstringFormatEntry.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubstringFormatEntry.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
SubstringFormatEntry(String description, Integer startPosition, Integer length)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static SubstringFormatEntry.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Integer	getLength()	The number of characters that should be there in the substring.
Integer	getStartPosition()	The starting position in the original string from where the substring should be extracted.
int	hashCode()
SubstringFormatEntry.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.datasafe.model.FormatEntry

getDescription

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

SubstringFormatEntry

@Deprecated
public SubstringFormatEntry(String description,
                            Integer startPosition,
                            Integer length)

Deprecated.

Method Detail

builder

public static SubstringFormatEntry.Builder builder()

Create a new builder.

toBuilder

public SubstringFormatEntry.Builder toBuilder()

getStartPosition

public Integer getStartPosition()

The starting position in the original string from where the substring should be extracted.

It can be either a positive or a negative integer. If It’s negative, the counting starts from the end of the string.

Returns:

the value

getLength

public Integer getLength()

The number of characters that should be there in the substring.

It should be an integer and greater than zero.

Returns:

the value

toString

public String toString()

Overrides:

toString in class FormatEntry

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class FormatEntry

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class FormatEntry

hashCode

public int hashCode()

Overrides:

hashCode in class FormatEntry