Oracle Cloud Infrastructure SDK 3.63.0 · com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

public abstract Class ExplicitlySetBmcModel

Base class for models implementing the explicitly set behavior. Subclasses should be annotated with

com.fasterxml.jackson.annotation.JsonFilter(com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel.EXPLICITLY_SET_FILTER_NAME)

All the properties that were explicitly set by user will be serialized, even if set to null.

Field Summary

Modifier and Type	Field and Description
private final Set<String>	__explicitlySet__ A hash set that stores the names of the properties that were explicitly set by user.
public static final String	EXPLICITLY_SET_FILTER_NAME The name of the explicitly set filter for usage in serialization / deserialization implementations
public static final String	EXPLICITLY_SET_PROPERTY_NAME The name of the explicitly set map property for usage in serialization / deserialization implementations

Constructor Summary

Access	Constructor and Description
public	ExplicitlySetBmcModel()

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
protected void	markPropertyAsExplicitlySet(String the name of the model property to mark as set by user. Should match the property name exactly. propertyName) Specify that a model property was explicitly set by user.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public boolean	Returns: whether the property was explicitly specified by user. wasPropertyExplicitlySet(String the name of the property. propertyName) Get whether a property was explicitly specified by user.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

__explicitlySet__	back to summary
private final Set<String> __explicitlySet__ A hash set that stores the names of the properties that were explicitly set by user. These properties will be included in the json request even if they were set to `null`. Annotations @JsonIgnore

EXPLICITLY_SET_FILTER_NAME	back to summary
public static final String EXPLICITLY_SET_FILTER_NAME The name of the explicitly set filter for usage in serialization / deserialization implementations

EXPLICITLY_SET_PROPERTY_NAME	back to summary
public static final String EXPLICITLY_SET_PROPERTY_NAME The name of the explicitly set map property for usage in serialization / deserialization implementations

Constructor Detail

ExplicitlySetBmcModel	back to summary
public ExplicitlySetBmcModel()

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

markPropertyAsExplicitlySet	back to summary
protected void markPropertyAsExplicitlySet(String propertyName) Specify that a model property was explicitly set by user. The method should be used inside property setters. Parameters propertyName:String the name of the model property to mark as set by user. Should match the property name exactly.

markPropertyAsExplicitlySet

back to summary

protected void markPropertyAsExplicitlySet(String propertyName)

Specify that a model property was explicitly set by user. The method should be used inside property setters.

Parameters

propertyName:String: the name of the model property to mark as set by user. Should match the property name exactly.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

wasPropertyExplicitlySet	back to summary
public boolean wasPropertyExplicitlySet(String propertyName) Get whether a property was explicitly specified by user. It is highly unlikely that this is the method you want to use as a user. Parameters propertyName:String the name of the property. Returns:boolean whether the property was explicitly specified by user.

wasPropertyExplicitlySet

back to summary

public boolean wasPropertyExplicitlySet(String propertyName)

Get whether a property was explicitly specified by user. It is highly unlikely that this is the method you want to use as a user.

Parameters

propertyName:String: the name of the property.

Returns:boolean

whether the property was explicitly specified by user.

public abstract Class ExplicitlySetBmcModel

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail