Top Description Inners Fields Constructors Methods
io.netty.util

public final Class Signal

extends Error
implements Constant<Signal>
Class Inheritance
All Implemented Interfaces
io.netty.util.Constant, java.lang.Comparable

A special Error which is used to signal some state or request by throwing it. Signal has an empty stack trace and has no cause to save the instantiation overhead.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class

Field Summary

Modifier and TypeField and Description
private final Signal.SignalConstant
private static final ConstantPool<Signal>
private static final long

Constructor Summary

AccessConstructor and Description
private
Signal(int id, String name)

Creates a new Signal with the specified name.

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(Signal
the object to be compared.
other
)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.
public boolean
equals(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 void
expect(Signal signal)

Check if the given Signal is the same as this instance.

public Throwable
fillInStackTrace()

Overrides java.lang.Throwable.fillInStackTrace.

Fills in the execution stack trace.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public int
id()

Implements io.netty.util.Constant.id.

Returns the unique number assigned to this Constant.
public Throwable
initCause(Throwable
the cause (which is saved for later retrieval by the getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
cause
)

Overrides java.lang.Throwable.initCause.

Initializes the cause of this throwable to the specified value.
public String
name()

Implements io.netty.util.Constant.name.

Returns the name of this Constant.
public String
toString()

Overrides java.lang.Throwable.toString.

Returns a short description of this throwable.
public static Signal
valueOf(String name)

Returns the Signal of the specified name.

public static Signal
valueOf(Class<?> firstNameComponent, String secondNameComponent)

Shortcut of valueOf(firstNameComponent.getName() + "#" + secondNameComponent).

Field Detail

constantback to summary
private final Signal.SignalConstant constant
poolback to summary
private static final ConstantPool<Signal> pool
serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.lang.Error.serialVersionUID.

Constructor Detail

Signalback to summary
private Signal(int id, String name)

Creates a new Signal with the specified name.

Method Detail

compareToback to summary
public int compareTo(Signal other)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
other:Signal

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations
@Override
equalsback to summary
public boolean equals(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: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
expectback to summary
public void expect(Signal signal)

Check if the given Signal is the same as this instance. If not an IllegalStateException will be thrown.

fillInStackTraceback to summary
public Throwable fillInStackTrace()

Overrides java.lang.Throwable.fillInStackTrace.

Doc from java.lang.Throwable.fillInStackTrace.

Fills in the execution stack trace. This method records within this Throwable object information about the current state of the stack frames for the current thread.

If the stack trace of this Throwable is not writable, calling this method has no effect.

Returns:Throwable

a reference to this Throwable instance.

Annotations
@Override
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
idback to summary
public int id()

Implements io.netty.util.Constant.id.

Doc from io.netty.util.Constant.id.

Returns the unique number assigned to this Constant.

Annotations
@Override
initCauseback to summary
public Throwable initCause(Throwable cause)

Overrides java.lang.Throwable.initCause.

Doc from java.lang.Throwable.initCause.

Initializes the cause of this throwable to the specified value. (The cause is the throwable that caused this throwable to get thrown.)

This method can be called at most once. It is generally called from within the constructor, or immediately after creating the throwable. If this throwable was created with Throwable(Throwable) or Throwable(String, Throwable), this method cannot be called even once.

An example of using this method on a legacy throwable type without other support for setting the cause is:

try {
    lowLevelOp();
} catch (LowLevelException le) {
    throw (HighLevelException)
          new HighLevelException().initCause(le); // Legacy constructor
}
Parameters
cause:Throwable

the cause (which is saved for later retrieval by the getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

Returns:Throwable

a reference to this Throwable instance.

Annotations
@Override
nameback to summary
public String name()

Implements io.netty.util.Constant.name.

Doc from io.netty.util.Constant.name.

Returns the name of this Constant.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Throwable.toString.

Doc from java.lang.Throwable.toString.

Returns a short description of this throwable. The result is the concatenation of:

  • the name of the class of this object
  • ": " (a colon and a space)
  • the result of invoking this object's getLocalizedMessage method
If getLocalizedMessage returns null, then just the class name is returned.
Returns:String

a string representation of this throwable.

Annotations
@Override
valueOfback to summary
public static Signal valueOf(String name)

Returns the Signal of the specified name.

valueOfback to summary
public static Signal valueOf(Class<?> firstNameComponent, String secondNameComponent)

Shortcut of valueOf(firstNameComponent.getName() + "#" + secondNameComponent).

io.netty.util back to summary

private final Class Signal.SignalConstant

extends AbstractConstant<Signal.SignalConstant>
Class Inheritance

Constructor Summary

AccessConstructor and Description
pack-priv
SignalConstant(int id, String name)

Method Summary

Inherited from io.netty.util.AbstractConstant:
compareToequalshashCodeidnametoString

Constructor Detail

SignalConstantback to summary
pack-priv SignalConstant(int id, String name)