org.apache.metamodel.spring

Class SpringResource

java.lang.Object

org.apache.metamodel.util.AbstractResource

org.apache.metamodel.spring.SpringResource

All Implemented Interfaces:

HasName, Resource

public class SpringResource
extends AbstractResource
implements Resource

A Resource implementation based on spring's similar Resource concept.

Constructor Summary

Constructors

Constructor and Description
SpringResource(org.springframework.core.io.Resource resource)

Method Summary

Modifier and Type	Method and Description
OutputStream	append() Opens up an OutputStream to append to the resource.
long	getLastModified() Gets the last modified timestamp value (measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970)) of the resource, if available.
String	getName() Gets the name of the resource, typically a filename or other identifying string
String	getQualifiedPath() Gets the qualified path of the resource, which typically includes slash or backslash separated nodes in a hierarical tree structure.
org.springframework.core.io.Resource	getResource() Gets the underlying spring Resource object.
long	getSize() Gets the size (in number of bytes) of this resource's data.
boolean	isExists() Determines if the resource referenced by this object exists or not.
boolean	isReadOnly() Determines if the file is read only, or if writes are also possible.
InputStream	read() Opens up an InputStream to read from the resource.
OutputStream	write() Opens up an OutputStream to write to the resource.

Methods inherited from class org.apache.metamodel.util.AbstractResource

append, read, read, read, toString, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.metamodel.util.Resource

append, read, read, read, write

Constructor Detail

SpringResource

public SpringResource(org.springframework.core.io.Resource resource)

Method Detail

append

public OutputStream append()
                    throws ResourceException

Description copied from interface: Resource

Opens up an OutputStream to append to the resource. Consumers of this method are expected to invoke the OutputStream.close() method manually. If possible, the other append(...) method is preferred over this one, since it guarantees proper closing of the resource's handles.

Specified by:

append in interface Resource

Returns:

Throws:

ResourceException

write

public OutputStream write()
                   throws ResourceException

Description copied from interface: Resource

Opens up an OutputStream to write to the resource. Consumers of this method are expected to invoke the OutputStream.close() method manually. If possible, the other write(...) method is preferred over this one, since it guarantees proper closing of the resource's handles.

Specified by:

write in interface Resource

Returns:

Throws:

ResourceException

getLastModified

public long getLastModified()

Description copied from interface: Resource

Gets the last modified timestamp value (measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970)) of the resource, if available. If the last modified date is not available, -1 is returned.

Specified by:

getLastModified in interface Resource

Returns:

getName

public String getName()

Description copied from interface: Resource

Gets the name of the resource, typically a filename or other identifying string

Specified by:

getName in interface HasName

Specified by:

getName in interface Resource

getQualifiedPath

public String getQualifiedPath()

Description copied from interface: Resource

Gets the qualified path of the resource, which typically includes slash or backslash separated nodes in a hierarical tree structure.

Specified by:

getQualifiedPath in interface Resource

Returns:

getSize

public long getSize()

Description copied from interface: Resource

Gets the size (in number of bytes) of this resource's data. An approximated number is allowed. If the size is not determinable without actually reading through the whole contents of the resource, -1 is returned.

Specified by:

getSize in interface Resource

Returns:

isExists

public boolean isExists()

Description copied from interface: Resource

Determines if the resource referenced by this object exists or not.

Specified by:

isExists in interface Resource

Returns:

isReadOnly

public boolean isReadOnly()

Description copied from interface: Resource

Determines if the file is read only, or if writes are also possible.

Specified by:

isReadOnly in interface Resource

Returns:

read

public InputStream read()
                 throws ResourceException

Description copied from interface: Resource

Opens up an InputStream to read from the resource. Consumers of this method are expected to invoke the InputStream.close() method manually. If possible, the other read(...) methods are preferred over this one, since they guarantee proper closing of the resource's handles.

Specified by:

read in interface Resource

Returns:

Throws:

ResourceException

getResource

public org.springframework.core.io.Resource getResource()

Gets the underlying spring Resource object.

Returns: