A partition consists of a title, subtitle, and its body text content. The partitions are an abstract representation of a segment in a larger textual document.
It is implementation dependent how a consumer of a partitioned text content will display the partitions. As a general rule of thumb, they are displayed in sequential order with their titles preceding them.
Partitioned text contents are usually used by script models to provide information about a code segment where the information is collected from multiple sources. These text contents are usually display in a tooltip in the IDE for providing information to the user.
public boolean | Indicates whether some other object is "equal to" this one. |
public Iterable< | Gets the partitions this instance contains. |
public int | hashCode() Gets the hash code of the partitioned text content. |
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
The equals
method for class Object
implements the most discriminating possible equivalence
relation on objects; that is, for any non-null reference values x
and y
, this method returns
true
if and only if x
and y
refer to the same object (x == y
has the value
true
).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden,
so as to maintain the general contract for the hashCode
method, which states that equal objects must have
equal hash codes.
true
if this object is the same as the obj argument; false
otherwise.The returned iterable contains the partitions in the iteration order. It is recommended to use a LinkedHashSet underlying implementation to avoid partitions with duplicate contents.
The returned iterable is recommended to be unmodifiable.
The has code is defined to be the following:
getPartitions().hashCode()The partitions hash code is computed according to the Set.hashCode() definition.
Returns a hash code value for the object.This method is supported for the benefit of hash tables such as those provided by 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 inequals
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(Object)
method, then calling thehashCode
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(
Object) method, then calling thehashCode
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.
As much as is reasonably practical, the hashCode method defined by class Object
does return distinct
integers for distinct objects. (This is typically implemented by converting the internal address of the object
into an integer, but this implementation technique is not required by the Java™ programming language.)