Spring Framework 6.1.4 · org.springframework.aot.hint.ResourcePatternHint

A hint that describes resources that should be made available at runtime.

Each pattern may be a simple path which has a one-to-one mapping to a resource on the classpath, or alternatively may contain the special * character to indicate a wildcard match. For example:

file.properties: matches just the file.properties file at the root of the classpath.
com/example/file.properties: matches just the file.properties file in com/example/.
*.properties: matches all the files with a .properties extension anywhere in the classpath.
com/example/*.properties: matches all the files with a .properties extension in com/example/ and its child directories at any depth.
com/example/*: matches all the files in com/example/ and its child directories at any depth.

A resource pattern must not start with a slash (/) unless it is the root directory.

Modifier and Type	Field and Description
private final String	pattern
private final TypeReference	reachableType

Access	Constructor and Description
pack-priv	ResourcePatternHint(String pattern, TypeReference reachableType)

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	Returns: the pattern getPattern() Return the pattern to use for identifying the resources to match.
public TypeReference	getReachableType() Implements org.springframework.aot.hint.ConditionalHint.getReachableType. Return the type that should be reachable for this hint to apply, or `null` if this hint should always been applied.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public Pattern	Returns: the regex pattern toRegex() Return the regex `Pattern` to use for identifying the resources to match.

pattern	back to summary
private final String pattern

reachableType	back to summary
private final TypeReference reachableType Annotations @Nullable

ResourcePatternHint	back to summary
pack-priv ResourcePatternHint(String pattern, TypeReference reachableType)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object o) 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 o: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 o)

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

o: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

getPattern	back to summary
public String getPattern() Return the pattern to use for identifying the resources to match. Returns:String the pattern

getPattern

back to summary

public String getPattern()

Return the pattern to use for identifying the resources to match.

Returns:String: the pattern

getReachableType back to summary

getReachableType	back to summary
public TypeReference getReachableType() Implements org.springframework.aot.hint.ConditionalHint.getReachableType. Doc from org.springframework.aot.hint.ConditionalHint.getReachableType. Return the type that should be reachable for this hint to apply, or `null` if this hint should always been applied. Returns:TypeReference the reachable type, if any Annotations @Nullable @Override

public TypeReference getReachableType()

Implements org.springframework.aot.hint.ConditionalHint.getReachableType.

Doc from org.springframework.aot.hint.ConditionalHint.getReachableType.

Return the type that should be reachable for this hint to apply, or null if this hint should always been applied.

Returns:TypeReference

the reachable type, if any

Annotations

@Nullable
@Override

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

toRegex back to summary

toRegex	back to summary
public Pattern toRegex() Return the regex `Pattern` to use for identifying the resources to match. Returns:Pattern the regex pattern

public Pattern toRegex()

Return the regex Pattern to use for identifying the resources to match.

Returns:Pattern: the regex pattern

public final Class ResourcePatternHint

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail