Top Description Fields Constructors Methods
org.springframework.core.io.support

public final Record PropertySourceDescriptor

extends Record
Class Inheritance
Record Components
locations:List<String>
the locations to consider
ignoreResourceNotFound:boolean
whether a failure to find a property resource should be ignored
name:String
the name of the property source, or null to infer one
propertySourceFactory:Class<? extends PropertySourceFactory>
the type of PropertySourceFactory to use, or null to use the default
encoding:String
the encoding, or null to use the default encoding
Imports
java.util.Arrays, .List, org.springframework.lang.Nullable
Descriptor for a PropertySource.
Author
Stephane Nicoll
Since
6.0
See Also
org.springframework.core.env.PropertySource, org.springframework.context.annotation.PropertySource

Field Summary

Modifier and TypeField and Description
private final String
encoding

Record Component accessed by encoding().

the encoding, or null to use the default encoding
private final boolean
ignoreResourceNotFound

Record Component accessed by ignoreResourceNotFound().

whether a failure to find a property resource should be ignored
private final List<String>
locations

Record Component accessed by locations().

the locations to consider
private final String
name

Record Component accessed by name().

the name of the property source, or null to infer one
private final Class<? extends PropertySourceFactory>
propertySourceFactory

Record Component accessed by propertySourceFactory().

the type of PropertySourceFactory to use, or null to use the default

Constructor Summary

AccessConstructor and Description
public
PropertySourceDescriptor(String...
the locations to consider
locations)

Create a descriptor with the specified locations.

public
PropertySourceDescriptor(List<String> locations, boolean ignoreResourceNotFound, String name, Class<? extends PropertySourceFactory> propertySourceFactory, String encoding)

Method Summary

Modifier and TypeMethod and Description
public String
encoding()

Record Component getter of encoding.

Record Component the encoding, or null to use the default encoding

public final boolean
equals(Object
the reference object with which to compare.
o)

Implements abstract java.lang.Record.equals.

Indicates whether some other object is "equal to" this one.

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public boolean
ignoreResourceNotFound()

Record Component getter of ignoreResourceNotFound.

Record Component whether a failure to find a property resource should be ignored

public List<String>
locations()

Record Component getter of locations.

Record Component the locations to consider

public String
name()

Record Component getter of name.

Record Component the name of the property source, or null to infer one

public Class<? extends PropertySourceFactory>
propertySourceFactory()

Record Component getter of propertySourceFactory.

Record Component the type of PropertySourceFactory to use, or null to use the default

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

encodingback to summary
private final String encoding

Record Component accessed by encoding().

the encoding, or null to use the default encoding

Annotations
@Nullable
ignoreResourceNotFoundback to summary
private final boolean ignoreResourceNotFound

Record Component accessed by ignoreResourceNotFound().

whether a failure to find a property resource should be ignored

locationsback to summary
private final List<String> locations

Record Component accessed by locations().

the locations to consider

nameback to summary
private final String name

Record Component accessed by name().

the name of the property source, or null to infer one

Annotations
@Nullable
propertySourceFactoryback to summary
private final Class<? extends PropertySourceFactory> propertySourceFactory

Record Component accessed by propertySourceFactory().

the type of PropertySourceFactory to use, or null to use the default

Annotations
@Nullable

Constructor Detail

PropertySourceDescriptorback to summary
public PropertySourceDescriptor(String... locations)

Create a descriptor with the specified locations.

Parameters
locations:String[]

the locations to consider

PropertySourceDescriptorback to summary
public PropertySourceDescriptor(List<String> locations, boolean ignoreResourceNotFound, String name, Class<? extends PropertySourceFactory> propertySourceFactory, String encoding)

Method Detail

encodingback to summary
public String encoding()

Record Component getter of encoding.

Record Component
the encoding, or null to use the default encoding
Annotations
@Nullable
equalsback to summary
public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: 

    R copy = new R(r.c1(), r.c2(), ..., r.cn());
then it must be the case that r.equals(copy).
Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this record is equal to the argument; false otherwise.

hashCodeback to summary
public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

Returns:int

a hash code value for this record.

ignoreResourceNotFoundback to summary
public boolean ignoreResourceNotFound()

Record Component getter of ignoreResourceNotFound.

Record Component
whether a failure to find a property resource should be ignored
locationsback to summary
public List<String> locations()

Record Component getter of locations.

Record Component
the locations to consider
nameback to summary
public String name()

Record Component getter of name.

Record Component
the name of the property source, or null to infer one
Annotations
@Nullable
propertySourceFactoryback to summary
public Class<? extends PropertySourceFactory> propertySourceFactory()

Record Component getter of propertySourceFactory.

Record Component
the type of PropertySourceFactory to use, or null to use the default
Annotations
@Nullable
toStringback to summary
public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

Returns:String

a string representation of the object.