org.apache.commons.vfs2.provider

Class AbstractVfsComponent

java.lang.Object

org.apache.commons.vfs2.provider.AbstractVfsComponent

All Implemented Interfaces:

Closeable, AutoCloseable, VfsComponent

Direct Known Subclasses:

AbstractFilesCache, AbstractFileSystem, AbstractVfsContainer, DefaultFileReplicator

public abstract class AbstractVfsComponent
extends Object
implements VfsComponent

A partial VfsComponent implementation.

Constructor Summary

Constructors

Constructor and Description
AbstractVfsComponent() Constructs a new instance for subclasses.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the provider.
protected VfsComponentContext	getContext() Returns the context for this provider.
protected org.apache.commons.logging.Log	getLogger() Returns the logger for this file system to use.
void	init() Initializes the component.
void	setContext(VfsComponentContext context) Sets the context for this file system provider.
void	setLogger(org.apache.commons.logging.Log log) Sets the Logger to use for the component.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractVfsComponent

public AbstractVfsComponent()

Constructs a new instance for subclasses.

Method Detail

close

public void close()

Closes the provider. This implementation does nothing.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface VfsComponent

getContext

protected final VfsComponentContext getContext()

Returns the context for this provider.

Returns:

provider context

getLogger

protected final org.apache.commons.logging.Log getLogger()

Returns the logger for this file system to use.

Returns:

logger for this file system

init

public void init()
          throws FileSystemException

Initializes the component. This implementation does nothing.

Specified by:

init in interface VfsComponent

Throws:

FileSystemException - if an error occurs.

setContext

public final void setContext(VfsComponentContext context)

Sets the context for this file system provider.

Specified by:

setContext in interface VfsComponent

Parameters:

context - The VfsComponentContext.

setLogger

public final void setLogger(org.apache.commons.logging.Log log)

Sets the Logger to use for the component.

Specified by:

setLogger in interface VfsComponent

Parameters:

log - The Log to use.