org.ojai

Interface OjaiCodec<T>

Type Parameters:

T - the encoded object type

@API.Public
public interface OjaiCodec<T>

Implementation of this interface can be used to encode/decode OJAI Object to/from a target/source format <T>

Method Summary

Modifier and Type	Method and Description
QueryCondition	decodeCondition(T encodedCondition) Decodes an instance of <T> into an OJAI QueryCondition
Document	decodeDocument(T encodedDocument) Decodes an instance of <T> into an OJAI Document
DocumentMutation	decodeMutation(T encodedMutation) Decodes an instance of <T> into an OJAI DocumentMutation
Query	decodeQuery(T encodedQuery, Document options) Decodes an instance of <T> into an OJAI Query
T	encodeCondition(QueryCondition condition) Encodes an OJAI QueryCondition into an instance of <T>
T	encodeDocument(Document document) Encodes an OJAI Document into an instance of <T>
T	encodeMutation(DocumentMutation mutation) Encodes an OJAI DocumentMutation into an instance of <T>
T	encodeQuery(Query query) Encodes an OJAI Query into an instance of <T>

Method Detail

encodeDocument

T encodeDocument(@API.NonNullable
                 Document document)
          throws EncodingException

Encodes an OJAI Document into an instance of <T>

Parameters:

document - OJAI Document to encode

Returns:

an instance of <T>

Throws:

EncodingException

decodeDocument

Document decodeDocument(@API.NonNullable
                        T encodedDocument)
                 throws DecodingException

Decodes an instance of <T> into an OJAI Document

Parameters:

encodedDocument - an instance of <T> containing encoded OJAI Document

Returns:

an OJAI Document

Throws:

DecodingException

encodeQuery

T encodeQuery(@API.NonNullable
              Query query)
       throws EncodingException

Encodes an OJAI Query into an instance of <T>

Parameters:

query - OJAI Query to encode

Returns:

an instance of <T>

Throws:

EncodingException

decodeQuery

Query decodeQuery(@API.NonNullable
                  T encodedQuery,
                  @API.Nullable
                  Document options)
           throws DecodingException

Decodes an instance of <T> into an OJAI Query

Parameters:

encodedQuery - an instance of <T> containing encoded OJAI Query

Returns:

an OJAI Query

Throws:

DecodingException

encodeCondition

T encodeCondition(@API.NonNullable
                  QueryCondition condition)
           throws EncodingException

Encodes an OJAI QueryCondition into an instance of <T>

Parameters:

condition - OJAI QueryCondition to encode

Returns:

an instance of <T>

Throws:

EncodingException

decodeCondition

QueryCondition decodeCondition(@API.NonNullable
                               T encodedCondition)
                        throws DecodingException

Decodes an instance of <T> into an OJAI QueryCondition

Parameters:

encodedCondition - an instance of <T> containing encoded OJAI QueryCondition

Returns:

an OJAI QueryCondition

Throws:

DecodingException

encodeMutation

T encodeMutation(@API.NonNullable
                 DocumentMutation mutation)
          throws EncodingException

Encodes an OJAI DocumentMutation into an instance of <T>

Parameters:

condition - OJAI DocumentMutation to encode

Returns:

an instance of <T>

Throws:

EncodingException

decodeMutation

DocumentMutation decodeMutation(@API.NonNullable
                                T encodedMutation)
                         throws DecodingException

Decodes an instance of <T> into an OJAI DocumentMutation

Parameters:

encodedMutation - an instance of <T> containing encoded OJAI DocumentMutation

Returns:

an OJAI DocumentMutation

Throws:

DecodingException