Spring Framework 6.1.4 · org.springframework.core.io.support.EncodedResource

Modifier and Type	Field and Description
private final Charset	charset
private final String	encoding
private final Resource	resource

Constructor Summary

Access	Constructor and Description
public	EncodedResource(Resource the `Resource` to hold (never `null`) resource) Create a new `EncodedResource` for the given `Resource`, not specifying an explicit encoding or `Charset`.
public	EncodedResource(Resource the `Resource` to hold (never `null`) resource, String the encoding to use for reading from the resource encoding) Create a new `EncodedResource` for the given `Resource`, using the specified `encoding`.
public	EncodedResource(Resource the `Resource` to hold (never `null`) resource, Charset the `Charset` to use for reading from the resource charset) Create a new `EncodedResource` for the given `Resource`, using the specified `Charset`.
private	EncodedResource(Resource resource, String encoding, Charset charset)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public final Charset	getCharset() Return the `Charset` to use for reading from the resource, or `null` if none specified.
public String	getContentAsString() Returns the contents of the specified resource as a string, using the specified `Charset` or encoding (if any).
public final String	getEncoding() Return the encoding to use for reading from the resource, or `null` if none specified.
public InputStream	getInputStream() Implements org.springframework.core.io.InputStreamSource.getInputStream. Open an `InputStream` for the specified resource, ignoring any specified `Charset` or encoding.
public Reader	getReader() Open a `java.io.Reader` for the specified resource, using the specified `Charset` or encoding (if any).
public final Resource	getResource() Return the `Resource` held by this `EncodedResource`.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	requiresReader() Determine whether a `Reader` is required as opposed to an `InputStream`, i.e. whether an encoding or a `Charset` has been specified.
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

Field Detail

charset	back to summary
private final Charset charset Annotations @Nullable

encoding	back to summary
private final String encoding Annotations @Nullable

resource	back to summary
private final Resource resource

Constructor Detail

EncodedResource back to summary

EncodedResource	back to summary
public EncodedResource(Resource resource) Create a new `EncodedResource` for the given `Resource`, not specifying an explicit encoding or `Charset`. Parameters resource:Resource the `Resource` to hold (never `null`)

public EncodedResource(Resource resource)

Create a new EncodedResource for the given Resource, not specifying an explicit encoding or Charset.

Parameters

resource:Resource: the Resource to hold (never null)

EncodedResource back to summary

EncodedResource	back to summary
public EncodedResource(Resource resource, String encoding) Create a new `EncodedResource` for the given `Resource`, using the specified `encoding`. Parameters resource:Resource the `Resource` to hold (never `null`) encoding:String the encoding to use for reading from the resource

public EncodedResource(Resource resource, String encoding)

Create a new EncodedResource for the given Resource, using the specified encoding.

Parameters

resource:Resource: the Resource to hold (never null)
encoding:String: the encoding to use for reading from the resource

EncodedResource back to summary

EncodedResource	back to summary
public EncodedResource(Resource resource, Charset charset) Create a new `EncodedResource` for the given `Resource`, using the specified `Charset`. Parameters resource:Resource the `Resource` to hold (never `null`) charset:Charset the `Charset` to use for reading from the resource

public EncodedResource(Resource resource, Charset charset)

Create a new EncodedResource for the given Resource, using the specified Charset.

Parameters

resource:Resource: the Resource to hold (never null)
charset:Charset: the Charset to use for reading from the resource

EncodedResource	back to summary
private EncodedResource(Resource resource, String encoding, Charset charset)

Method Detail

equals back to summary

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

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

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

getCharset back to summary

getCharset	back to summary
public final Charset getCharset() Return the `Charset` to use for reading from the resource, or `null` if none specified. Annotations @Nullable

public final Charset getCharset()

Return the Charset to use for reading from the resource, or null if none specified.

Annotations

@Nullable

getContentAsString back to summary

getContentAsString	back to summary
public String getContentAsString() throws IOException Returns the contents of the specified resource as a string, using the specified `Charset` or encoding (if any). Exceptions IOException: if opening the resource failed Since 6.0.5 See Also `Resource#getContentAsString(Charset)`

public String getContentAsString() throws IOException

Returns the contents of the specified resource as a string, using the specified Charset or encoding (if any).

Exceptions

IOException:: if opening the resource failed

Since

6.0.5

See Also

Resource#getContentAsString(Charset)

getEncoding back to summary

getEncoding	back to summary
public final String getEncoding() Return the encoding to use for reading from the resource, or `null` if none specified. Annotations @Nullable

public final String getEncoding()

Return the encoding to use for reading from the resource, or null if none specified.

Annotations

@Nullable

getInputStream back to summary

getInputStream	back to summary
public InputStream getInputStream() throws IOException Implements org.springframework.core.io.InputStreamSource.getInputStream. Open an `InputStream` for the specified resource, ignoring any specified `Charset` or encoding. Returns:InputStream Doc from org.springframework.core.io.InputStreamSource.getInputStream. the input stream for the underlying resource (must not be `null`) Annotations @Override Exceptions IOException: if opening the InputStream failed See Also `requiresReader()`, `getReader()`

public InputStream getInputStream() throws IOException

Implements org.springframework.core.io.InputStreamSource.getInputStream.

Open an InputStream for the specified resource, ignoring any specified Charset or encoding.

Returns:InputStream

Doc from org.springframework.core.io.InputStreamSource.getInputStream.

the input stream for the underlying resource (must not be null)

Annotations

@Override

Exceptions

IOException:: if opening the InputStream failed

See Also

requiresReader(), getReader()

getReader back to summary

getReader	back to summary
public Reader getReader() throws IOException Open a `java.io.Reader` for the specified resource, using the specified `Charset` or encoding (if any). Exceptions IOException: if opening the Reader failed See Also `requiresReader()`, `getInputStream()`

public Reader getReader() throws IOException

Open a java.io.Reader for the specified resource, using the specified Charset or encoding (if any).

Exceptions

IOException:: if opening the Reader failed

See Also

requiresReader(), getInputStream()

getResource	back to summary
public final Resource getResource() Return the `Resource` held by this `EncodedResource`.

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

requiresReader back to summary

requiresReader	back to summary
public boolean requiresReader() Determine whether a `Reader` is required as opposed to an `InputStream`, i.e. whether an encoding or a `Charset` has been specified. See Also `getReader()`, `getInputStream()`

public boolean requiresReader()

Determine whether a Reader is required as opposed to an InputStream, i.e. whether an encoding or a Charset has been specified.

See Also: getReader(), getInputStream()

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. Returns:String a string representation of the object 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.

Returns:String

a string representation of the object

Annotations

@Override

public Class EncodedResource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail