org.apache.metamodel.util

Class ClasspathResource

java.lang.Object

org.apache.metamodel.util.AbstractResource

org.apache.metamodel.util.ClasspathResource

All Implemented Interfaces:

Serializable, HasName, Resource

public class ClasspathResource
extends AbstractResource
implements Serializable

A Resource based on a classpath entry

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClasspathResource(String resourcePath)

Method Summary

Modifier and Type	Method and Description
OutputStream	append() Opens up an OutputStream to append to the resource.
protected ClassLoader	getClassLoader()
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.
String	getResourcePath() Gets the name of the classpath entry
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.
String	toString()
OutputStream	write() Opens up an OutputStream to write to the resource.

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

append, read, read, read, write

Methods inherited from class java.lang.Object

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

Constructor Detail

ClasspathResource

public ClasspathResource(String resourcePath)

Method Detail

toString

public String toString()

Overrides:

toString in class AbstractResource

getResourcePath

public String getResourcePath()

Gets the name of the classpath entry

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:

getClassLoader

protected ClassLoader getClassLoader()

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

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:

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:

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:

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:

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