org.apache.commons.weaver.model

Class ScanRequest

java.lang.Object

org.apache.commons.weaver.model.ScanRequest

public class ScanRequest
extends Object

Scan request object describing the types of elements in which a given Weaver or Cleaner is interested.

Constructor Summary

Constructors

Constructor and Description
ScanRequest()

Method Summary

Modifier and Type	Method and Description
ScanRequest	add(WeaveInterest interest) Register a WeaveInterest.
ScanRequest	addSupertypes(Class<?>... types) Register one or more types whose subtypes you are looking for.
Iterable<WeaveInterest>	getInterests() Get registered WeaveInterests.
Set<Class<?>>	getSupertypes() Get registered Classes whose subtypes will be returned.
boolean	isConstrained() Learn whether this ScanRequest has been constrained.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScanRequest

public ScanRequest()

Method Detail

add

public ScanRequest add(WeaveInterest interest)

Register a WeaveInterest.

Parameters:

interest - WeaveInterest to add

Returns:

this, fluently

addSupertypes

public ScanRequest addSupertypes(Class<?>... types)

Register one or more types whose subtypes you are looking for.

Parameters:

types - Classes to add

Returns:

this, fluently

getInterests

public Iterable<WeaveInterest> getInterests()

Get registered WeaveInterests.

Returns:

Iterable

getSupertypes

public Set<Class<?>> getSupertypes()

Get registered Classes whose subtypes will be returned.

Returns:

Set

isConstrained

public boolean isConstrained()

Learn whether this ScanRequest has been constrained. An unconstrained ScanRequest will return all known types.

Returns:

boolean

Since:

1.3