org.ojai

Interface Container

All Known Subinterfaces:

Document, DocumentMutation, Query, QueryCondition

All Known Implementing Classes:

DocumentBase

public interface Container

A container of OJAI objects. Not all implementing classes are required to implement all methods.

Since:

3.0

Method Summary

Modifier and Type	Method and Description
default Container	empty() Empties this container, removing all children.
default boolean	isEmpty()
default boolean	isReadOnly()
default int	size()

Method Detail

size

default int size()

Returns:

the number of children in this container.

isEmpty

default boolean isEmpty()

Returns:

true if this container is empty, i.e. size() == 0.

isReadOnly

default boolean isReadOnly()

empty

default Container empty()

Empties this container, removing all children.

Returns:

this for chaining.

Throws:

ReadOnlyObjectException - if this container is read-only.