Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.ShowDocumentParams

Modifier and Type	Field and Description
private Boolean	external Indicates to show the resource in an external program.
private Range	selection An optional selection range if the document is a text document.
private Boolean	takeFocus An optional property to indicate whether the editor showing the document should take focus or not.
private String	uri The document uri to show.

Access	Constructor and Description
public	ShowDocumentParams()
public	ShowDocumentParams(final String uri)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(final Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Boolean	getExternal() Indicates to show the resource in an external program.
public Range	getSelection() An optional selection range if the document is a text document.
public Boolean	getTakeFocus() An optional property to indicate whether the editor showing the document should take focus or not.
public String	getUri() The document uri to show.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setExternal(final Boolean external) Indicates to show the resource in an external program.
public void	setSelection(final Range selection) An optional selection range if the document is a text document.
public void	setTakeFocus(final Boolean takeFocus) An optional property to indicate whether the editor showing the document should take focus or not.
public void	setUri(final String uri) The document uri to show.
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

external	back to summary
private Boolean external Indicates to show the resource in an external program. To show for example https://www.eclipse.org/ in the default WEB browser set to `true`.

selection	back to summary
private Range selection An optional selection range if the document is a text document. Clients might ignore the property if an external program is started or the file is not a text file.

takeFocus	back to summary
private Boolean takeFocus An optional property to indicate whether the editor showing the document should take focus or not. Clients might ignore this property if an external program is started.

uri	back to summary
private String uri The document uri to show. Annotations @NonNull

ShowDocumentParams	back to summary
public ShowDocumentParams()

ShowDocumentParams	back to summary
public ShowDocumentParams(final String uri)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(final 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. Annotations @Override

public boolean equals(final 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.

Annotations

@Override

getExternal	back to summary
public Boolean getExternal() Indicates to show the resource in an external program. To show for example https://www.eclipse.org/ in the default WEB browser set to `true`.

getSelection	back to summary
public Range getSelection() An optional selection range if the document is a text document. Clients might ignore the property if an external program is started or the file is not a text file.

getTakeFocus	back to summary
public Boolean getTakeFocus() An optional property to indicate whether the editor showing the document should take focus or not. Clients might ignore this property if an external program is started.

getUri	back to summary
public String getUri() The document uri to show. Annotations @NonNull

getUri

back to summary

public String getUri()

The document uri to show.

Annotations

@NonNull

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. 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.

Annotations

@Override

setExternal	back to summary
public void setExternal(final Boolean external) Indicates to show the resource in an external program. To show for example https://www.eclipse.org/ in the default WEB browser set to `true`.

setSelection	back to summary
public void setSelection(final Range selection) An optional selection range if the document is a text document. Clients might ignore the property if an external program is started or the file is not a text file.

setTakeFocus	back to summary
public void setTakeFocus(final Boolean takeFocus) An optional property to indicate whether the editor showing the document should take focus or not. Clients might ignore this property if an external program is started.

setUri	back to summary
public void setUri(final String uri) The document uri to show.

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. 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.

Annotations

@Override

public Class ShowDocumentParams

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail