Package aQute.bnd.osgi

Class FileResource

java.lang.Object

aQute.bnd.osgi.FileResource

All Implemented Interfaces:

Resource, Closeable, AutoCloseable

public class FileResource
extends Object
implements Resource

Resource for a file. This class implementation assumes the file does not change underneath this object.

Field Summary

Fields

Modifier and Type	Field	Description
private ByteBuffer	buffer
private static final ByteBuffer	CLOSED
private boolean	deleteOnClose
private String	extra
private final Path	file
private final long	lastModified
private final long	size
private static final int	THRESHOLD

Constructor Summary

Constructors

Constructor	Description
FileResource(Resource r)	Turn a resource into a file so that anything in the conversion is properly caught
FileResource(File file)
FileResource(Path path)
FileResource(Path path, BasicFileAttributes attrs)

Method Summary

Modifier and Type	Method	Description
ByteBuffer	buffer()
void	close()
void	deleteOnClose(boolean b)
String	getExtra()	Use Resource.decodeExtra(String) to properly decode the ZIP extra field structured binary data from the returned String.
File	getFile()
long	lastModified()
InputStream	openInputStream()
void	setExtra(String extra)	Use Resource.encodeExtra(byte[]) to properly encode the ZIP extra field structured binary data into the specified String.
long	size()
String	toString()
void	write(File file)
void	write(OutputStream out)
void	write(Path path)

Methods inherited from class java.lang.Object

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

Field Details

THRESHOLD

private static final int THRESHOLD

See Also:

• Constant Field Values

CLOSED

private static final ByteBuffer CLOSED

buffer

private ByteBuffer buffer

file

private final Path file

extra

private String extra

deleteOnClose

private boolean deleteOnClose

lastModified

private final long lastModified

size

private final long size

Constructor Details

FileResource

public FileResource(File file)
             throws IOException

Throws:

IOException

FileResource

public FileResource(Path path)
             throws IOException

Throws:

IOException

FileResource

FileResource(Path path,
 BasicFileAttributes attrs)
      throws IOException

Throws:

IOException

FileResource

public FileResource(Resource r)
             throws Exception

Turn a resource into a file so that anything in the conversion is properly caught

Parameters:

r -

Throws:

Exception

Method Details

buffer

public ByteBuffer buffer()
                  throws Exception

Specified by:

buffer in interface Resource

Throws:

Exception

openInputStream

public InputStream openInputStream()
                            throws Exception

Specified by:

openInputStream in interface Resource

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object

write

public void write(OutputStream out)
           throws Exception

Specified by:

write in interface Resource

Throws:

Exception

write

public void write(File file)
           throws Exception

Specified by:

write in interface Resource

Throws:

Exception

write

public void write(Path path)
           throws Exception

Specified by:

write in interface Resource

Throws:

Exception

lastModified

public long lastModified()

Specified by:

lastModified in interface Resource

getExtra

public String getExtra()

Description copied from interface: Resource

Use Resource.decodeExtra(String) to properly decode the ZIP extra field structured binary data from the returned String.

Specified by:

getExtra in interface Resource

Returns:

A String encoding the ZIP extra field.

setExtra

public void setExtra(String extra)

Description copied from interface: Resource

Use Resource.encodeExtra(byte[]) to properly encode the ZIP extra field structured binary data into the specified String.

Specified by:

setExtra in interface Resource

Parameters:

extra - A String encoding the ZIP extra field.

size

public long size()

Specified by:

size in interface Resource

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

deleteOnClose

public void deleteOnClose(boolean b)

getFile

public File getFile()