Vert.x 4.5.13 · io.vertx.core.http.StreamPriority · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public static final int	DEFAULT_DEPENDENCY
public static final boolean	DEFAULT_EXCLUSIVE
public static final short	DEFAULT_WEIGHT
private int	dependency
private boolean	exclusive
private short	weight

Access	Constructor and Description
public	StreamPriority()
public	StreamPriority(JsonObject json) References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element.
public	StreamPriority(StreamPriority other)

Method Summary

Modifier and Type	Method and Description
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 int	Returns: A stream identifier for the stream that this stream depends on. getDependency()
public short	Returns: An integer value between `1` and `256` representing a priority weight for the stream. getWeight()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	Returns: A flag indicating that the stream dependency is exclusive. isExclusive()
public StreamPriority	Returns: a reference to this, so the API can be used fluently setDependency(int the new value dependency) Set the priority dependency value.
public StreamPriority	Returns: a reference to this, so the API can be used fluently setExclusive(boolean the new value exclusive) Set the priority exclusive value.
public StreamPriority	Returns: a reference to this, so the API can be used fluently setWeight(short the new value weight) Set the priority weight.
public JsonObject	toJson() References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

DEFAULT_DEPENDENCY	back to summary
public static final int DEFAULT_DEPENDENCY

DEFAULT_EXCLUSIVE	back to summary
public static final boolean DEFAULT_EXCLUSIVE

DEFAULT_WEIGHT	back to summary
public static final short DEFAULT_WEIGHT

dependency	back to summary
private int dependency

exclusive	back to summary
private boolean exclusive

weight	back to summary
private short weight

StreamPriority	back to summary
public StreamPriority()

StreamPriority	back to summary
public StreamPriority(JsonObject json) References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

StreamPriority	back to summary
public StreamPriority(StreamPriority other)

Method Detail

equals back to summary

equals	back 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

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

getDependency	back to summary
public int getDependency() Returns:int A stream identifier for the stream that this stream depends on.

getWeight	back to summary
public short getWeight() Returns:short An integer value between `1` and `256` representing a priority weight for the stream.

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

isExclusive	back to summary
public boolean isExclusive() Returns:boolean A flag indicating that the stream dependency is exclusive.

setDependency	back to summary
public StreamPriority setDependency(int dependency) Set the priority dependency value. Parameters dependency:int the new value Returns:StreamPriority a reference to this, so the API can be used fluently

setDependency

back to summary

public StreamPriority setDependency(int dependency)

Set the priority dependency value.

Parameters

dependency:int: the new value

Returns:StreamPriority

a reference to this, so the API can be used fluently

setExclusive	back to summary
public StreamPriority setExclusive(boolean exclusive) Set the priority exclusive value. Parameters exclusive:boolean the new value Returns:StreamPriority a reference to this, so the API can be used fluently

setExclusive

back to summary

public StreamPriority setExclusive(boolean exclusive)

Set the priority exclusive value.

Parameters

exclusive:boolean: the new value

Returns:StreamPriority

a reference to this, so the API can be used fluently

setWeight	back to summary
public StreamPriority setWeight(short weight) Set the priority weight. Parameters weight:short the new value Returns:StreamPriority a reference to this, so the API can be used fluently

setWeight

back to summary

public StreamPriority setWeight(short weight)

Set the priority weight.

Parameters

weight:short: the new value

Returns:StreamPriority

a reference to this, so the API can be used fluently

toJson	back to summary
public JsonObject toJson() References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

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

public Class StreamPriority

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail