DocumentCondition (communication-document 1.0.0-b2 API)

```
public interface DocumentCondition
```
An unit condition to run a document collection select

See Also:

DocumentCollectionManager.select(DocumentQuery)

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`DocumentCondition.DocumentConditionProvider` A provider of `DocumentCondition` where it will create from two parameters: The first one is `Document` The second one is the Condition

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static DocumentCondition`	`and(DocumentCondition... conditions)` Returns a new `DocumentCondition` aggregating ,as ¨AND", all the conditions as just one condition.
`DocumentCondition`	`and(DocumentCondition condition)` Creates a new `DocumentCondition` using the `Condition.AND`
`static DocumentCondition`	`between(Document document)` Creates a `DocumentCondition` that has a `Condition.BETWEEN`, it means a select will scanning to a document collection that is between two values informed on a document name.
`static DocumentCondition`	`eq(Document document)` Creates a `DocumentCondition` that has a `Condition.EQUALS`, it means a select will scanning to a document collection that has the same name and equals value informed in this document.
`Condition`	`getCondition()` Gets the conditions to be used in the select
`Document`	`getDocument()` Gets the document to be used in the select
`static DocumentCondition`	`gt(Document document)` Creates a `DocumentCondition` that has a `Condition.GREATER_THAN`, it means a select will scanning to a document collection that has the same name and the value greater than informed in this document.
`static DocumentCondition`	`gte(Document document)` Creates a `DocumentCondition` that has a `Condition.GREATER_EQUALS_THAN`, it means a select will scanning to a document collection that has the same name and the value greater or equals than informed in this document.
`static DocumentCondition`	`in(Document document)` Creates a `DocumentCondition` that has a `Condition.IN`, it means a select will scanning to a document collection that has the same name and the value is within informed in this document.
`static DocumentCondition`	`like(Document document)` Creates a `DocumentCondition` that has a `Condition.LIKE`, it means a select will scanning to a document collection that has the same name and the value is like than informed in this document.
`static DocumentCondition`	`lt(Document document)` Creates a `DocumentCondition` that has a `Condition.LESSER_THAN`, it means a select will scanning to a document collection that has the same name and the value lesser than informed in this document.
`static DocumentCondition`	`lte(Document document)` Creates a `DocumentCondition` that has a `Condition.LESSER_EQUALS_THAN`, it means a select will scanning to a document collection that has the same name and the value lesser or equals than informed in this document.
`DocumentCondition`	`negate()` Creates a new `DocumentCondition` negating the current one
`static DocumentCondition`	`or(DocumentCondition... conditions)` Returns a new `DocumentCondition` aggregating ,as ¨OR", all the conditions as just one condition.
`DocumentCondition`	`or(DocumentCondition condition)` Creates a new `DocumentCondition` using the `Condition.OR`

- Method Detail
  - getDocument
```
Document getDocument()
```
    Gets the document to be used in the select
    
    Returns:
    
    a document instance
  - getCondition
```
Condition getCondition()
```
    Gets the conditions to be used in the select
    
    Returns:
    
    a Condition instance
    
    See Also:
    
    Condition
  - and
```
DocumentCondition and(DocumentCondition condition)
```
    Creates a new DocumentCondition using the Condition.AND
    
    Parameters:
    
    condition - the condition to be agregated
    
    Returns:
    
    the conditions joined as AND
    
    Throws:
    
    NullPointerException - when the condition is null
  - negate
```
DocumentCondition negate()
```
    Creates a new DocumentCondition negating the current one
    
    Returns:
    
    the negated condition
    
    See Also:
    
    Condition.NOT
  - or
```
DocumentCondition or(DocumentCondition condition)
```
    Creates a new DocumentCondition using the Condition.OR
    
    Parameters:
    
    condition - the condition to be agregated
    
    Returns:
    
    the conditions joined as AND
    
    Throws:
    
    NullPointerException - when the condition is null
  - eq
```
static DocumentCondition eq(Document document)
```
    Creates a DocumentCondition that has a Condition.EQUALS, it means a select will scanning to a document collection that has the same name and equals value informed in this document.
    
    Parameters:
    
    document - a column instance
    
    Returns:
    
    a DocumentCondition with Condition.EQUALS
    
    Throws:
    
    NullPointerException - when column is null
  - gt
```
static DocumentCondition gt(Document document)
```
    Creates a DocumentCondition that has a Condition.GREATER_THAN, it means a select will scanning to a document collection that has the same name and the value greater than informed in this document.
    
    Parameters:
    
    document - a column instance
    
    Returns:
    
    a DocumentCondition with Condition.GREATER_THAN
    
    Throws:
    
    NullPointerException - when column is null
  - gte
```
static DocumentCondition gte(Document document)
```
    Creates a DocumentCondition that has a Condition.GREATER_EQUALS_THAN, it means a select will scanning to a document collection that has the same name and the value greater or equals than informed in this document.
    
    Parameters:
    
    document - a column instance
    
    Returns:
    
    a DocumentCondition with Condition.GREATER_EQUALS_THAN
    
    Throws:
    
    NullPointerException - when column is null
  - lt
```
static DocumentCondition lt(Document document)
```
    Creates a DocumentCondition that has a Condition.LESSER_THAN, it means a select will scanning to a document collection that has the same name and the value lesser than informed in this document.
    
    Parameters:
    
    document - a column instance
    
    Returns:
    
    a DocumentCondition with Condition.LESSER_THAN
    
    Throws:
    
    NullPointerException - when column is null
  - lte
```
static DocumentCondition lte(Document document)
```
    Creates a DocumentCondition that has a Condition.LESSER_EQUALS_THAN, it means a select will scanning to a document collection that has the same name and the value lesser or equals than informed in this document.
    
    Parameters:
    
    document - a document instance
    
    Returns:
    
    a DocumentCondition with Condition.LESSER_EQUALS_THAN
    
    Throws:
    
    NullPointerException - when column is null
  - in
```
static DocumentCondition in(Document document)
```
    Creates a DocumentCondition that has a Condition.IN, it means a select will scanning to a document collection that has the same name and the value is within informed in this document.
    
    Parameters:
    
    document - a column instance
    
    Returns:
    
    a DocumentCondition with Condition.IN
    
    Throws:
    
    NullPointerException - when column is null
  - like
```
static DocumentCondition like(Document document)
```
    Creates a DocumentCondition that has a Condition.LIKE, it means a select will scanning to a document collection that has the same name and the value is like than informed in this document.
    
    Parameters:
    
    document - a column instance
    
    Returns:
    
    a DocumentCondition with Condition.LIKE
    
    Throws:
    
    NullPointerException - when column is null
  - between
```
static DocumentCondition between(Document document)
```
    Creates a DocumentCondition that has a Condition.BETWEEN, it means a select will scanning to a document collection that is between two values informed on a document name. The document must have a Document.get() an Iterable implementation with just two elements.
    
    Parameters:
    
    document - a column instance
    
    Returns:
    
    The between condition
    
    Throws:
    
    NullPointerException - when document is null
    
    IllegalArgumentException - When the document neither has an Iterable instance or two elements on an Iterable.
  - and
```
static DocumentCondition and(DocumentCondition... conditions)
```
    Returns a new DocumentCondition aggregating ,as ¨AND", all the conditions as just one condition. The Document will storage the Condition.getNameField() as key and the value gonna be the List of all conditions, in other words.
    Given:
```
 
 Document age = Document.of("age", 26);
 Document name = Document.of("name", "otavio");
 DocumentCondition condition = DocumentCondition.eq(name).and(DocumentCondition.gte(age));
 
 
```
    The getDocument() will have "_AND" as key and the list of condition as value.
    Parameters:
    
    conditions - the conditions to be aggregated
    
    Returns:
    
    the new DocumentCondition instance
    
    Throws:
    
    NullPointerException - when the conditions is null
  - or
```
static DocumentCondition or(DocumentCondition... conditions)
```
    Returns a new DocumentCondition aggregating ,as ¨OR", all the conditions as just one condition. The Document will storage the Condition.getNameField() as key and the value gonna be the List of all conditions, in other words.
    Given:
```
 
 Document age = Document.of("age", 26);
 Document name = Document.of("name", "otavio");
 ColumnCondition condition = DocumentCondition.eq(name).or(DocumentCondition.gte(age));
 
 
```
    The getDocument() will have "_OR" as key and the list of condition as value.
    Parameters:
    
    conditions - the conditions to be aggregated
    
    Returns:
    
    the new DocumentCondition instance
    
    Throws:
    
    NullPointerException - when the condition is null

Interface DocumentCondition

Nested Class Summary

Method Summary

Method Detail

getDocument

getCondition

and

negate

or

eq

gt

gte

lt

lte

in

like

between

and

or