org.apache.isis.core.metamodel.facets.collections.modify

Interface CollectionFacet

All Superinterfaces:

Facet

All Known Implementing Classes:

CollectionFacetAbstract, CollectionFacetForFreeStandingList, JavaArrayFacet, JavaCollectionFacet

public interface CollectionFacet
extends Facet

Attached to ObjectSpecifications that represent a collection.

Factories of (implementations of this) facet should ensure that a TypeOfFacet is also attached to the same facet holder. The getTypeOfFacet() is a convenience for this.

Method Summary

Methods

Modifier and Type	Method and Description
Collection<ObjectAdapter>	collection(ObjectAdapter collectionAdapter) Returns an unmodifiable Collection of ObjectAdapters.
boolean	contains(ObjectAdapter collectionAdapter, ObjectAdapter element)
ObjectAdapter	firstElement(ObjectAdapter collectionAdapter)
TypeOfFacet	getTypeOfFacet() Convenience method that returns the TypeOfFacet on this facet's holder.
void	init(ObjectAdapter collectionAdapter, ObjectAdapter[] elements) Set the contents of this collection.
Iterable<ObjectAdapter>	iterable(ObjectAdapter collectionAdapter)
Iterator<ObjectAdapter>	iterator(ObjectAdapter collectionAdapter)
int	size(ObjectAdapter collection)

Methods inherited from interface org.apache.isis.core.metamodel.facetapi.Facet

alwaysReplace, facetType, getFacetHolder, getUnderlyingFacet, isDerived, isNoop, setFacetHolder, setUnderlyingFacet

Method Detail

size

int size(ObjectAdapter collection)

iterable

Iterable<ObjectAdapter> iterable(ObjectAdapter collectionAdapter)

iterator

Iterator<ObjectAdapter> iterator(ObjectAdapter collectionAdapter)

collection

Collection<ObjectAdapter> collection(ObjectAdapter collectionAdapter)

Returns an unmodifiable Collection of ObjectAdapters.

firstElement

ObjectAdapter firstElement(ObjectAdapter collectionAdapter)

contains

boolean contains(ObjectAdapter collectionAdapter,
               ObjectAdapter element)

init

void init(ObjectAdapter collectionAdapter,
        ObjectAdapter[] elements)

Set the contents of this collection.

getTypeOfFacet

TypeOfFacet getTypeOfFacet()

Convenience method that returns the TypeOfFacet on this facet's holder.