Top Description Fields Constructors Methods
com.fasterxml.jackson.dataformat.cbor

public Class CBORSimpleValue

extends Object
Class Inheritance

Simple value object to be used for exposing undefined "simple values" when encountered during parsing. Note that as of Jackson 2.12, this class is not yet used for exposing simple values: instead they are report as com.fasterxml.jackson.core.JsonToken#VALUE_NUMBER_INTs.

Simple values left undefined in CBOR 1.0 specification contain values [0 - 19], [32, 255]: other values are not used to represent general simple values. Specifically, values below 0, above 255 or in range [20, 31] (inclusive) are never exposed.

Values are not guaranteed to be canonicalized, but being immutable may be reused (and in future possible canonicalized if that makes sense).

Note that it is possible that some of above-mentioned values may be defined to have specific meaning and get reported using some other mechanism.

Since
2.12

Field Summary

Modifier and TypeField and Description
protected final int
_value

Actual numeric value represented.

Constructor Summary

AccessConstructor and Description
public
CBORSimpleValue(int value)

Method Summary

Modifier and TypeMethod 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

Returns:

Simple integer value this instance represents
getValue
()

Accessor for the simple integer value represented

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

_valueback to summary
protected final int _value

Actual numeric value represented. Usually should be in range of [0-19][32-255].

Constructor Detail

CBORSimpleValueback to summary
public CBORSimpleValue(int value)

Method Detail

equalsback 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
getValueback to summary
public int getValue()

Accessor for the simple integer value represented

Returns:int

Simple integer value this instance represents

hashCodeback 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
toStringback 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