org.pfsw.file

Class NamedCloseable

java.lang.Object

org.pfsw.file.NamedCloseable

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

NamedInputStream, NamedOutputStream, NamedReader, NamedWriter

public abstract class NamedCloseable
extends java.lang.Object
implements java.io.Closeable

An abstract implementation to decorate a Closeable with a name.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NamedCloseable()
protected	NamedCloseable(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the underlying closeable catching any exception.
protected abstract java.io.Closeable	getCloseable() Returns the closeable that is associated with the name defined in this class.
java.lang.String	getName()
void	setName(java.lang.String name) Sets the name of the associated closeable.

Methods inherited from class java.lang.Object

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

Constructor Detail

NamedCloseable

protected NamedCloseable()

NamedCloseable

protected NamedCloseable(java.lang.String name)

Method Detail

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

Sets the name of the associated closeable.

Parameters:

name - The new name (must not be null).

Throws:

java.lang.IllegalArgumentException - If the given name is null.

close

public void close()

Closes the underlying closeable catching any exception.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

getCloseable

protected abstract java.io.Closeable getCloseable()

Returns the closeable that is associated with the name defined in this class.