Top Description Inners Fields Constructors Methods
org.newsclub.net.unix

public Class NamedInteger

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Known Direct Subclasses
org.newsclub.net.unix.AFSYSTEMSocketAddress.SysAddr, org.newsclub.net.unix.AFTIPCSocketAddress.AddressType, org.newsclub.net.unix.AFTIPCSocketAddress.Scope
Annotations
@NonNullByDefault
Imports
java.io.Serializable, java.util.HashSet, .Objects, .Set, org.eclipse.jdt.annotation.NonNullByDefault, .Nullable
A "named integer", usually used for constants. See the concrete implementations for usage.
Author
Christian Kohlschütter

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static interface
NamedInteger.HasOfValue

Marks a subclass that provides a method "public static T ofValue(int v)" that allows casting an integer to this type via reflection.

protected static interface
NamedInteger.UndefinedValueConstructor<
The instance type.
T extends NamedInteger>

Constructor for "undefined" values.

Field Summary

Modifier and TypeField and Description
private final int
id

The ID value.

private final String
name

The name.

private static final long
serialVersionUID

Constructor Summary

AccessConstructor and Description
protected
NamedInteger(int
The value.
id)

Creates a new NamedInteger instance, without actually naming it.

protected
NamedInteger(String
The name.
name, int
The value.
id)

Creates a new NamedInteger instance.

Method Summary

Modifier and TypeMethod and Description
public final boolean
equals(@Nullable Object
the reference object with which to compare.
obj)

Overrides java.lang.Object.equals.

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

public final int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

protected static final <
The instance type.
T extends NamedInteger> T[]

Returns:

The verified VALUES array.
init(T[]
The VALUES array.
values)

Ensures that the VALUES array is configured correctly.

public final String

Returns:

The name.
name()

Returns the name.

protected static final <
The instance type.
T extends NamedInteger> T

Returns:

The instance.
ofValue(T[]
The VALUES array.
values, NamedInteger.UndefinedValueConstructor<T>
The constructor for undefined values.
constr, int
The value.
v)

Returns an instance given an integer value.

public final String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public final int

Returns:

The value.
value()

Returns the value.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

idback to summary
private final int id

The ID value.

nameback to summary
private final String name

The name.

serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

NamedIntegerback to summary
protected NamedInteger(int id)

Creates a new NamedInteger instance, without actually naming it. A name of "UNDEFINED" is used.

Parameters
id:int

The value.

NamedIntegerback to summary
protected NamedInteger(String name, int id)

Creates a new NamedInteger instance.

Parameters
name:String

The name.

id:int

The value.

Method Detail

equalsback to summary
public final boolean equals(@Nullable Object obj)

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
obj:@Nullable 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
hashCodeback to summary
public final 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
initback to summary
protected static final <T extends NamedInteger> T[] init(T[] values)

Ensures that the VALUES array is configured correctly.

Parameters
<T>
The instance type.
values:T[]

The VALUES array.

Returns:T[]

The verified VALUES array.

nameback to summary
public final String name()

Returns the name.

Returns:String

The name.

ofValueback to summary
protected static final <T extends NamedInteger> T ofValue(T[] values, NamedInteger.UndefinedValueConstructor<T> constr, int v)

Returns an instance given an integer value.

Parameters
<T>
The instance type.
values:T[]

The VALUES array.

constr:NamedInteger.UndefinedValueConstructor<T>

The constructor for undefined values.

v:int

The value.

Returns:T

The instance.

toStringback to summary
public final 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
valueback to summary
public final int value()

Returns the value.

Returns:int

The value.

org.newsclub.net.unix back to summary

public Interface NamedInteger.HasOfValue

Marks a subclass that provides a method "public static T ofValue(int v)" that allows casting an integer to this type via reflection.
org.newsclub.net.unix back to summary

protected Interface NamedInteger.UndefinedValueConstructor<T extends NamedInteger>

Annotations
@FunctionalInterface
Type Parameters
<T>
The instance type.
Constructor for "undefined" values.

Method Summary

Modifier and TypeMethod and Description
public T

Returns:

The instance.
newInstance(int
The value.
id)

Creates a new "undefined" value instance.

Method Detail

newInstanceback to summary
public T newInstance(int id)

Creates a new "undefined" value instance.

Parameters
id:int

The value.

Returns:T

The instance.