OriginTrackedResource (Spring Boot 2.4.13 API)

java.lang.Object
- org.springframework.boot.origin.OriginTrackedResource

All Implemented Interfaces:

OriginProvider, InputStreamSource, Resource

Direct Known Subclasses:

OriginTrackedResource.OriginTrackedWritableResource
```
public class OriginTrackedResource
extends Object
implements Resource, OriginProvider
```
Decorator that can be used to add Origin information to a Resource or WritableResource.

Since:

2.4.0

Author:

Phillip Webb

See Also:

of(Resource, Origin), of(WritableResource, Origin), OriginProvider

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class OriginTrackedResource.OriginTrackedWritableResource
Variant of OriginTrackedResource for WritableResource instances.

Nested Classes
Modifier and Type	Class and Description
`static class`	`OriginTrackedResource.OriginTrackedWritableResource` Variant of `OriginTrackedResource` for `WritableResource` instances.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`contentLength()`
`Resource`	`createRelative(String relativePath)`
`boolean`	`equals(Object obj)`
`boolean`	`exists()`
`String`	`getDescription()`
`File`	`getFile()`
`String`	`getFilename()`
`InputStream`	`getInputStream()`
`Origin`	`getOrigin()` Return the source origin or `null` if the origin is not known.
`Resource`	`getResource()`
`URI`	`getURI()`
`URL`	`getURL()`
`int`	`hashCode()`
`boolean`	`isFile()`
`boolean`	`isOpen()`
`boolean`	`isReadable()`
`long`	`lastModified()`
`static OriginTrackedResource`	`of(Resource resource, Origin origin)` Return a new `origin tracked` version the given `Resource`.
`static OriginTrackedResource.OriginTrackedWritableResource`	`of(WritableResource resource, Origin origin)` Return a new `origin tracked` version the given `WritableResource`.
`ReadableByteChannel`	`readableChannel()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - getInputStream
```
public InputStream getInputStream()
                           throws IOException
```
    Specified by:
    
    getInputStream in interface InputStreamSource
    
    Throws:
    
    IOException
  - exists
```
public boolean exists()
```
    Specified by:
    
    exists in interface Resource
  - isReadable
```
public boolean isReadable()
```
    Specified by:
    
    isReadable in interface Resource
  - isOpen
```
public boolean isOpen()
```
    Specified by:
    
    isOpen in interface Resource
  - isFile
```
public boolean isFile()
```
    Specified by:
    
    isFile in interface Resource
  - getURL
```
public URL getURL()
           throws IOException
```
    Specified by:
    
    getURL in interface Resource
    
    Throws:
    
    IOException
  - getURI
```
public URI getURI()
           throws IOException
```
    Specified by:
    
    getURI in interface Resource
    
    Throws:
    
    IOException
  - getFile
```
public File getFile()
             throws IOException
```
    Specified by:
    
    getFile in interface Resource
    
    Throws:
    
    IOException
  - readableChannel
```
public ReadableByteChannel readableChannel()
                                    throws IOException
```
    Specified by:
    
    readableChannel in interface Resource
    
    Throws:
    
    IOException
  - contentLength
```
public long contentLength()
                   throws IOException
```
    Specified by:
    
    contentLength in interface Resource
    
    Throws:
    
    IOException
  - lastModified
```
public long lastModified()
                  throws IOException
```
    Specified by:
    
    lastModified in interface Resource
    
    Throws:
    
    IOException
  - createRelative
```
public Resource createRelative(String relativePath)
                        throws IOException
```
    Specified by:
    
    createRelative in interface Resource
    
    Throws:
    
    IOException
  - getFilename
```
public String getFilename()
```
    Specified by:
    
    getFilename in interface Resource
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface Resource
  - getResource
```
public Resource getResource()
```
  - getOrigin
```
public Origin getOrigin()
```
    Description copied from interface: OriginProvider
    
    Return the source origin or null if the origin is not known.
    
    Specified by:
    
    getOrigin in interface OriginProvider
    
    Returns:
    
    the origin or null
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - of
```
public static OriginTrackedResource.OriginTrackedWritableResource of(WritableResource resource,
                                                                     Origin origin)
```
    Return a new origin tracked version the given WritableResource.
    
    Parameters:
    
    resource - the tracked resource
    
    origin - the origin of the resource
    
    Returns:
    
    a OriginTrackedResource.OriginTrackedWritableResource instance
  - of
```
public static OriginTrackedResource of(Resource resource,
                                       Origin origin)
```
    Return a new origin tracked version the given Resource.
    
    Parameters:
    
    resource - the tracked resource
    
    origin - the origin of the resource
    
    Returns:
    
    a OriginTrackedResource instance

Class OriginTrackedResource

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInputStream

exists

isReadable

isOpen

isFile

getURL

getURI

getFile

readableChannel

contentLength

lastModified

createRelative

getFilename

getDescription

getResource

getOrigin

equals

hashCode

toString

of

of