DefaultViewRow (java-client 2.0.0 API)

java.lang.Object
- com.couchbase.client.java.view.DefaultViewRow

All Implemented Interfaces:: ViewRow

public class DefaultViewRow
extends java.lang.Object
implements ViewRow

Constructor Summary

Constructors
Constructor and Description
`DefaultViewRow(CouchbaseEnvironment env, Bucket bucket, java.lang.String id, java.lang.Object key, java.lang.Object value)`

Method Summary

Methods
Modifier and Type	Method and Description
`JsonDocument`	`document()` Load the underlying document, if not reduced with the default view timeout.
`<D extends Document<?>> D`	`document(java.lang.Class<D> target)` Load the underlying document, if not reduced with the default view timeout.
`<D extends Document<?>> D`	`document(java.lang.Class<D> target, long timeout, java.util.concurrent.TimeUnit timeUnit)` Load the underlying document, if not reduced with a custom timeout.
`JsonDocument`	`document(long timeout, java.util.concurrent.TimeUnit timeUnit)` Load the underlying document, if not reduced with a custom timeout.
`java.lang.String`	`id()` The id of the document, if not reduced.
`java.lang.Object`	`key()` The key of the row index.
`java.lang.Object`	`value()` The value of the row index.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultViewRow
```
public DefaultViewRow(CouchbaseEnvironment env,
              Bucket bucket,
              java.lang.String id,
              java.lang.Object key,
              java.lang.Object value)
```
- Method Detail
  - id
```
public java.lang.String id()
```
    Description copied from interface: ViewRow
    
    The id of the document, if not reduced.
    
    Specified by:
    
    id in interface ViewRow
    
    Returns:
    the id of the document.
  - key
```
public java.lang.Object key()
```
    Description copied from interface: ViewRow
    
    The key of the row index.
    The object can be any valid JSON object, including JsonArray or JsonObject.
    
    Specified by:
    
    key in interface ViewRow
    
    Returns:
    the key.
  - value
```
public java.lang.Object value()
```
    Description copied from interface: ViewRow
    
    The value of the row index.
    The object can be any valid JSON object, including JsonArray or JsonObject.
    
    Specified by:
    
    value in interface ViewRow
    
    Returns:
    the value.
  - document
```
public JsonDocument document()
```
    Description copied from interface: ViewRow
    Load the underlying document, if not reduced with the default view timeout.
    This method throws:
    - java.util.concurrent.TimeoutException: If the timeout is exceeded.
    - com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed.
    - java.lang.IllegalStateException: If the view is reduced and the ID is null.
    - com.couchbase.client.java.error.TranscodingException: If the response document could not be decoded.
    Specified by:
    
    document in interface ViewRow
    
    Returns:
    the loaded document, null if not found.
  - document
```
public JsonDocument document(long timeout,
                    java.util.concurrent.TimeUnit timeUnit)
```
    Description copied from interface: ViewRow
    Load the underlying document, if not reduced with a custom timeout.
    This method throws:
    - java.util.concurrent.TimeoutException: If the timeout is exceeded.
    - com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed.
    - java.lang.IllegalStateException: If the view is reduced and the ID is null.
    - com.couchbase.client.java.error.TranscodingException: If the response document could not be decoded.
    Specified by:
    
    document in interface ViewRow
    
    Parameters:
    timeout - the custom timeout.
    timeUnit - the time unit for the custom timeout.
    
    Returns:
    the loaded document, null if not found.
  - document
```
public <D extends Document<?>> D document(java.lang.Class<D> target)
```
    Description copied from interface: ViewRow
    Load the underlying document, if not reduced with the default view timeout.
    This method throws:
    - java.util.concurrent.TimeoutException: If the timeout is exceeded.
    - com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed.
    - java.lang.IllegalStateException: If the view is reduced and the ID is null.
    - com.couchbase.client.java.error.TranscodingException: If the response document could not be decoded.
    Specified by:
    
    document in interface ViewRow
    
    Parameters:
    target - the custom target document type.
    
    Returns:
    the loaded document, null if not found.
  - document
```
public <D extends Document<?>> D document(java.lang.Class<D> target,
                                 long timeout,
                                 java.util.concurrent.TimeUnit timeUnit)
```
    Description copied from interface: ViewRow
    Load the underlying document, if not reduced with a custom timeout.
    This method throws:
    - java.util.concurrent.TimeoutException: If the timeout is exceeded.
    - com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed.
    - java.lang.IllegalStateException: If the view is reduced and the ID is null.
    - com.couchbase.client.java.error.TranscodingException: If the response document could not be decoded.
    Specified by:
    
    document in interface ViewRow
    
    Parameters:
    target - the custom target document type.
    timeout - the custom timeout.
    timeUnit - the time unit for the custom timeout.
    
    Returns:
    the loaded document, null if not found.

Class DefaultViewRow

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultViewRow

Method Detail

id

key

value

document

document

document

document