DocumentEntity (communication-document 1.0.0-b2 API)

```
public interface DocumentEntity
```
A document-oriented database, or document store, is a computer program designed for storing, retrieving, and managing document-oriented information, also known as semi-structured data. D ocument-oriented databases are one of the main categories of NoSQL databases, and the popularity of the term "document-oriented database" has grown with the use of the term NoSQL itself. XML databases are a subclass of document-oriented databases that are optimized to work with XML documents. Graph databases are similar, but add another layer, the relationship, which allows them to link documents for rapid traversal.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`DocumentEntity.DocumentEntityProvider` A provider of `DocumentEntity` where it will return from the document entity name.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`add(Document document)` add a document within `DocumentEntity`
`void`	`add(String documentName, Object value)` add a document within `DocumentEntity`
`void`	`add(String documentName, Value value)` add a document within `DocumentEntity`
`void`	`addAll(Iterable<Document> documents)` add all documents within `DocumentEntity`
`void`	`clear()` Removes all Documents
`boolean`	`contains(String documentName)` Returns true if this DocumentEntity contains a document whose the name is informed
`DocumentEntity`	`copy()` make copy of itself
`Optional<Document>`	`find(String documentName)` Find document a document from document name
`Set<String>`	`getDocumentNames()` Returns a Set view of the names of document contained in Document Entity
`List<Document>`	`getDocuments()` List of all documents
`String`	`getName()` The collection name to `DocumentEntity`
`Collection<Value>`	`getValues()` Returns a Collection view of the values contained in this DocumentEntity.
`boolean`	`isEmpty()` Returns true if this list contains no elements.
`static DocumentEntity`	`of(String name)` Creates a `DocumentEntity` instance
`static DocumentEntity`	`of(String name, List<Document> documents)` Creates a `DocumentEntity` instance
`boolean`	`remove(String documentName)` Remove a Document whose name is informed in parameter.
`int`	`size()` Returns the number of elements in this list.
`Map<String,Object>`	`toMap()` Converts the columns to a Map where: the key is the name the column The value is the `Value.get()` of the map

- Method Detail
  - of
```
static DocumentEntity of(String name)
```
    Creates a DocumentEntity instance
    
    Parameters:
    
    name - the name of the collection
    
    Returns:
    
    a DocumentEntity instance
    
    Throws:
    
    NullPointerException - when name is null
  - of
```
static DocumentEntity of(String name,
                         List<Document> documents)
```
    Creates a DocumentEntity instance
    
    Parameters:
    
    name - the collection name
    
    documents - the intial document inside DocumentEntity
    
    Returns:
    
    a DocumentEntity instance
    
    Throws:
    
    NullPointerException - when either name or documents are null
  - getName
```
String getName()
```
    The collection name to DocumentEntity
    
    Returns:
    
    collection name
  - remove
```
boolean remove(String documentName)
```
    Remove a Document whose name is informed in parameter.
    
    Parameters:
    
    documentName - a document name
    
    Returns:
    
    if a column was removed or not
    
    Throws:
    
    NullPointerException - when documentName is null
  - getDocuments
```
List<Document> getDocuments()
```
    List of all documents
    
    Returns:
    
    all documents
  - add
```
void add(Document document)
```
    add a document within DocumentEntity
    
    Parameters:
    
    document - a document to be included
    
    Throws:
    
    UnsupportedOperationException - when this method is not supported
    
    NullPointerException - when document is null
  - add
```
void add(String documentName,
         Object value)
```
    add a document within DocumentEntity
    
    Parameters:
    
    documentName - a name of the document
    
    value - the information of the document
    
    Throws:
    
    UnsupportedOperationException - when this method is not supported
    
    NullPointerException - when either name or value are null
  - add
```
void add(String documentName,
         Value value)
```
    add a document within DocumentEntity
    
    Parameters:
    
    documentName - a name of the document
    
    value - the information of the document
    
    Throws:
    
    UnsupportedOperationException - when this method is not supported
    
    NullPointerException - when either name or value are null
  - addAll
```
void addAll(Iterable<Document> documents)
```
    add all documents within DocumentEntity
    
    Parameters:
    
    documents - documents to be included
    
    Throws:
    
    UnsupportedOperationException - when this method is not supported
    
    NullPointerException - when document is null
  - find
```
Optional<Document> find(String documentName)
```
    Find document a document from document name
    
    Parameters:
    
    documentName - a name of a document
    
    Returns:
    
    an Optional instance with the result
    
    Throws:
    
    NullPointerException - when documentName is null
  - size
```
int size()
```
    Returns the number of elements in this list.
    
    Returns:
    
    the number of elements in this list
  - isEmpty
```
boolean isEmpty()
```
    Returns true if this list contains no elements.
    
    Returns:
    
    true if this list contains no elements
  - copy
```
DocumentEntity copy()
```
    make copy of itself
    
    Returns:
    
    an instance copy
  - clear
```
void clear()
```
    Removes all Documents
  - getDocumentNames
```
Set<String> getDocumentNames()
```
    Returns a Set view of the names of document contained in Document Entity
    
    Returns:
    
    the keys
  - getValues
```
Collection<Value> getValues()
```
    Returns a Collection view of the values contained in this DocumentEntity.
    
    Returns:
    
    the collection of values
  - contains
```
boolean contains(String documentName)
```
    Returns true if this DocumentEntity contains a document whose the name is informed
    
    Parameters:
    
    documentName - the document name
    
    Returns:
    
    true if find a document and otherwise false
  - toMap
```
Map<String,Object> toMap()
```
    Converts the columns to a Map where: the key is the name the column The value is the Value.get() of the map
    
    Returns:
    
    a map instance

Interface DocumentEntity

Nested Class Summary

Method Summary

Method Detail

of

of

getName

remove

getDocuments

add

add

add

addAll

find

size

isEmpty

copy

clear

getDocumentNames

getValues

contains

toMap