org.apache.commons.weaver.model

Class WeaveEnvironment

java.lang.Object

org.apache.commons.weaver.model.WeaveEnvironment

public abstract class WeaveEnvironment
extends Object

Encapsulates the environment in which a Weaver or Cleaner must operate.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	WeaveEnvironment.Resource Represents a WeaveEnvironment resource.

Field Summary

Fields

Modifier and Type	Field and Description
ClassLoader	classLoader ClassLoader containing scannable and weavable classes.
Properties	config Configuration properties.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WeaveEnvironment(ClassLoader classLoader, Properties config, Logger log) Create a new WeaveEnvironment.

Method Summary

Modifier and Type	Method and Description
void	debug(String message, Object... args) Handle a debug message.
boolean	deleteClassfile(Class<?> cls) Delete the classfile for cls.
boolean	deleteClassfile(String classname) Delete the classfile for the specified class.
abstract boolean	deleteResource(String name) Delete the specified resource.
void	error(String message, Object... args) Handle an error message.
WeaveEnvironment.Resource	getClassfile(Class<?> cls) Get a WeaveEnvironment.Resource representing cls.
WeaveEnvironment.Resource	getClassfile(String classname) Get a WeaveEnvironment.Resource for the specified class.
protected abstract OutputStream	getOutputStream(String resourceName) Open an OutputStream for the specified resource.
WeaveEnvironment.Resource	getResource(String name) Get a WeaveEnvironment.Resource for the specified resource.
protected static String	getResourceName(String classname) Convert a classname into a resource name.
void	info(String message, Object... args) Handle an info message.
void	verbose(String message, Object... args) Handle a verbose message.
void	warn(String message, Object... args) Handle a warning message.

Methods inherited from class java.lang.Object

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

Field Detail

classLoader

public final ClassLoader classLoader

ClassLoader containing scannable and weavable classes.

config

public final Properties config

Configuration properties. By convention, any configuration property should start with its name, e.g. "privilizer".

Constructor Detail

WeaveEnvironment

protected WeaveEnvironment(ClassLoader classLoader,
                           Properties config,
                           Logger log)

Create a new WeaveEnvironment.

Parameters:

classLoader - property

config - property

log - property

Method Detail

getResourceName

protected static String getResourceName(String classname)

Convert a classname into a resource name.

Parameters:

classname - to convert

Returns:

String

debug

public void debug(String message,
                  Object... args)

Handle a debug message.

Parameters:

message - text

args - format

See Also:

String.format(String, Object...)

verbose

public void verbose(String message,
                    Object... args)

Handle a verbose message.

Parameters:

message - text

args - format

See Also:

String.format(String, Object...)

warn

public void warn(String message,
                 Object... args)

Handle a warning message.

Parameters:

message - text

args - format

See Also:

String.format(String, Object...)

info

public void info(String message,
                 Object... args)

Handle an info message.

Parameters:

message - text

args - format

See Also:

String.format(String, Object...)

error

public void error(String message,
                  Object... args)

Handle an error message.

Parameters:

message - text

args - format

See Also:

String.format(String, Object...)

getClassfile

public final WeaveEnvironment.Resource getClassfile(Class<?> cls)

Get a WeaveEnvironment.Resource representing cls.

Parameters:

cls - type

Returns:

WeaveEnvironment.Resource

getClassfile

public final WeaveEnvironment.Resource getClassfile(String classname)

Get a WeaveEnvironment.Resource for the specified class.

Parameters:

classname - of type

Returns:

WeaveEnvironment.Resource

getResource

public final WeaveEnvironment.Resource getResource(String name)

Get a WeaveEnvironment.Resource for the specified resource.

Parameters:

name - of resource

Returns:

WeaveEnvironment.Resource

deleteClassfile

public final boolean deleteClassfile(Class<?> cls)

Delete the classfile for cls.

Parameters:

cls - type

Returns:

whether successful

deleteClassfile

public final boolean deleteClassfile(String classname)

Delete the classfile for the specified class.

Parameters:

classname - of type

Returns:

whether successful

deleteResource

public abstract boolean deleteResource(String name)

Delete the specified resource.

Parameters:

name - to delete

Returns:

whether successful

getOutputStream

protected abstract OutputStream getOutputStream(String resourceName)
                                         throws IOException

Open an OutputStream for the specified resource.

Parameters:

resourceName - to open

Returns:

OutputStream

Throws:

IOException - on error