Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.FileOperationPattern

Modifier and Type	Field and Description
private String	glob The glob pattern to match.
private String	matches Whether to match files or folders with this pattern.
private FileOperationPatternOptions	options Additional options used during matching.

Access	Constructor and Description
public	FileOperationPattern()
public	FileOperationPattern(final String glob)

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 String	getGlob() The glob pattern to match.
public String	getMatches() Whether to match files or folders with this pattern.
public FileOperationPatternOptions	getOptions() Additional options used during matching.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setGlob(final String glob) The glob pattern to match.
public void	setMatches(final String matches) Whether to match files or folders with this pattern.
public void	setOptions(final FileOperationPatternOptions options) Additional options used during matching.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Field Detail

glob	back to summary
private String glob The glob pattern to match. Glob patterns can have the following syntax: `` to match one or more characters in a path segment `?` to match on one character in a path segment `` to match any number of path segments, including none `{}` to group sub patterns into an OR expression. (e.g. `/.{ts,js}` matches all TypeScript and JavaScript files) `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …) `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`) Annotations @NonNull

glob

back to summary

private String glob

The glob pattern to match. Glob patterns can have the following syntax:

`*` to match one or more characters in a path segment
`?` to match on one character in a path segment
`**` to match any number of path segments, including none
`{}` to group sub patterns into an OR expression. (e.g. `**/*.{ts,js}` matches all TypeScript and JavaScript files)
`[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
`[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)

Annotations

@NonNull

matches back to summary

matches	back to summary
private String matches Whether to match files or folders with this pattern. Matches both if undefined. See `FileOperationPatternKind` for allowed values.

private String matches

Whether to match files or folders with this pattern.

Matches both if undefined.

See FileOperationPatternKind for allowed values.

options	back to summary
private FileOperationPatternOptions options Additional options used during matching.

Constructor Detail

FileOperationPattern	back to summary
public FileOperationPattern()

FileOperationPattern	back to summary
public FileOperationPattern(final String glob)

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

getGlob	back to summary
public String getGlob() The glob pattern to match. Glob patterns can have the following syntax: `` to match one or more characters in a path segment `?` to match on one character in a path segment `` to match any number of path segments, including none `{}` to group sub patterns into an OR expression. (e.g. `/.{ts,js}` matches all TypeScript and JavaScript files) `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …) `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`) Annotations @NonNull

getGlob

back to summary

public String getGlob()

The glob pattern to match. Glob patterns can have the following syntax:

`*` to match one or more characters in a path segment
`?` to match on one character in a path segment
`**` to match any number of path segments, including none
`{}` to group sub patterns into an OR expression. (e.g. `**/*.{ts,js}` matches all TypeScript and JavaScript files)
`[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
`[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)

Annotations

@NonNull

getMatches back to summary

getMatches	back to summary
public String getMatches() Whether to match files or folders with this pattern. Matches both if undefined. See `FileOperationPatternKind` for allowed values.

public String getMatches()

Whether to match files or folders with this pattern.

Matches both if undefined.

See FileOperationPatternKind for allowed values.

getOptions	back to summary
public FileOperationPatternOptions getOptions() Additional options used during matching.

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

setGlob	back to summary
public void setGlob(final String glob) The glob pattern to match. Glob patterns can have the following syntax: `` to match one or more characters in a path segment `?` to match on one character in a path segment `` to match any number of path segments, including none `{}` to group sub patterns into an OR expression. (e.g. `/.{ts,js}` matches all TypeScript and JavaScript files) `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …) `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)

setGlob

back to summary

public void setGlob(final String glob)

The glob pattern to match. Glob patterns can have the following syntax:

`*` to match one or more characters in a path segment
`?` to match on one character in a path segment
`**` to match any number of path segments, including none
`{}` to group sub patterns into an OR expression. (e.g. `**/*.{ts,js}` matches all TypeScript and JavaScript files)
`[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
`[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)

setMatches back to summary

setMatches	back to summary
public void setMatches(final String matches) Whether to match files or folders with this pattern. Matches both if undefined. See `FileOperationPatternKind` for allowed values.

public void setMatches(final String matches)

Whether to match files or folders with this pattern.

Matches both if undefined.

See FileOperationPatternKind for allowed values.

setOptions	back to summary
public void setOptions(final FileOperationPatternOptions options) Additional options used during matching.

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 FileOperationPattern

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail