Package org.codehaus.plexus.collections
Interface ActiveCollection
-
- All Known Subinterfaces:
ActiveList,ActiveMap,ActiveSet
- All Known Implementing Classes:
AbstractActiveList,AbstractActiveMap,AbstractActiveSet,DefaultActiveList,DefaultActiveMap,DefaultActiveSet
public interface ActiveCollectionRepresents a collection-style view of aPlexusContainerinstance, which retrieves a fresh batch of component elements for each method call. This interface DOES NOT implementCollection, since it is used as a common parent for activeList,Set, andMapimplementations.
NOTE: All active collections are immutable, and will throw anUnsupportedOperationExceptionif a mutator method is called.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleancheckedIsEmpty()Same semantics asCollection.isEmpty()orMap.isEmpty(), except this method will throw aComponentLookupExceptionif one or more of the elements collected here fails during lookup.intcheckedSize()Same semantics asCollection.size()orMap.size(), except this method will throw aComponentLookupExceptionif one or more of the elements collected here fails during lookup.java.lang.StringgetRole()Retrive the role, or type of component, which is collected in the current instance.booleanisEmpty()Same semantics asCollection.isEmpty()orMap.isEmpty().intsize()Same semantics asCollection.size()orMap.size().
-
-
-
Method Detail
-
getRole
java.lang.String getRole()
Retrive the role, or type of component, which is collected in the current instance. The current collection will only "contain" elements that specify this role in their component definitions.
-
isEmpty
boolean isEmpty()
Same semantics asCollection.isEmpty()orMap.isEmpty().
-
checkedIsEmpty
boolean checkedIsEmpty() throws org.codehaus.plexus.component.repository.exception.ComponentLookupExceptionSame semantics asCollection.isEmpty()orMap.isEmpty(), except this method will throw aComponentLookupExceptionif one or more of the elements collected here fails during lookup.- Throws:
org.codehaus.plexus.component.repository.exception.ComponentLookupException
-
size
int size()
Same semantics asCollection.size()orMap.size().
-
checkedSize
int checkedSize() throws org.codehaus.plexus.component.repository.exception.ComponentLookupExceptionSame semantics asCollection.size()orMap.size(), except this method will throw aComponentLookupExceptionif one or more of the elements collected here fails during lookup.- Throws:
org.codehaus.plexus.component.repository.exception.ComponentLookupException
-
-