JsonSerializer (HCL Domino API 1.0.27-SNAPSHOT API)

```
public interface JsonSerializer
```
This interface allows for serialization of documents into JSON, both as strings and as implementation-specific Java object representations.
Implementations of this service are expected to be provided by additional integration modules, such as domino-jnx-jsonp.

Since:

1.0.7

Author:

Jesse Gallagher

Field Summary

Fields
Modifier and Type	Field and Description
`static Collection<String>`	`DEFAULT_EXCLUDED_ITEMS`
`static String`	`PROP_META_ADDEDTOFILE`
`static String`	`PROP_META_CREATED`
`static String`	`PROP_META_LASTACCESSED`
`static String`	`PROP_META_LASTMODIFIED`
`static String`	`PROP_META_LASTMODIFIEDINFILE`
`static String`	`PROP_META_NOTECLASS`
`static String`	`PROP_META_NOTEID`
`static String`	`PROP_META_UNID`
`static String`	`PROP_METADATA`
`static String`	`PROP_RANGE_FROM`
`static String`	`PROP_RANGE_TO`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`JsonSerializer`	`booleanItemNames(Collection<String> booleanItemNames)` Sets the item names that should be considered boolean values when serialized to JSON.
`JsonSerializer`	`booleanTrueValues(Collection<Object> trueValues)` Sets the values used to determine `true` and `false` when serializing items configured via `booleanItemNames(Collection)`.
`static JsonSerializer`	`createSerializer()` Constructs a new serializer using the first available JSON service.
`JsonSerializer`	`dateRangeFormat(DateRangeFormat format)` Sets the format for date/time range values.
`JsonSerializer`	`excludeItems(Collection<String> skippedItemNames)` Exclude items by name.
`JsonSerializer`	`excludeTypes(Collection<ItemDataType> excludedTypes)` Exclude item types.
`JsonSerializer`	`includeItems(Collection<String> includedItemNames)` Include only specific items by name.
`JsonSerializer`	`includeMetadata(boolean includeMetadata)` Sets whether to include a metadata object in the output JSON, using the "@meta" property.
`JsonSerializer`	`lowercaseProperties(boolean lowercaseProperties)` Sets whether property names in the emitted JSON should be lowercased.
`Object`	`toJson(Document doc)` Serializes the provided document as a JSON object using the implementation's native JSON type.
`default String`	`toJsonString(Document doc)` Serializes the provided document as a JSON string.

- Field Detail
  - DEFAULT_EXCLUDED_ITEMS
```
static final Collection<String> DEFAULT_EXCLUDED_ITEMS
```
  - PROP_METADATA
```
static final String PROP_METADATA
```
    See Also:
    
    Constant Field Values
  - PROP_META_NOTEID
```
static final String PROP_META_NOTEID
```
    See Also:
    
    Constant Field Values
  - PROP_META_UNID
```
static final String PROP_META_UNID
```
    See Also:
    
    Constant Field Values
  - PROP_META_CREATED
```
static final String PROP_META_CREATED
```
    See Also:
    
    Constant Field Values
  - PROP_META_LASTMODIFIED
```
static final String PROP_META_LASTMODIFIED
```
    See Also:
    
    Constant Field Values
  - PROP_META_LASTMODIFIEDINFILE
```
static final String PROP_META_LASTMODIFIEDINFILE
```
    See Also:
    
    Constant Field Values
  - PROP_META_LASTACCESSED
```
static final String PROP_META_LASTACCESSED
```
    See Also:
    
    Constant Field Values
  - PROP_META_ADDEDTOFILE
```
static final String PROP_META_ADDEDTOFILE
```
    See Also:
    
    Constant Field Values
  - PROP_META_NOTECLASS
```
static final String PROP_META_NOTECLASS
```
    See Also:
    
    Constant Field Values
  - PROP_RANGE_FROM
```
static final String PROP_RANGE_FROM
```
    See Also:
    
    Constant Field Values
  - PROP_RANGE_TO
```
static final String PROP_RANGE_TO
```
    See Also:
    
    Constant Field Values
- Method Detail
  - createSerializer
```
static JsonSerializer createSerializer()
```
    Constructs a new serializer using the first available JSON service.
    
    Returns:
    
    a new JsonSerializer implementation
    
    Throws:
    
    IllegalStateException - if there is no registered serializer implementation
  - excludeItems
```
JsonSerializer excludeItems(Collection<String> skippedItemNames)
```
    Exclude items by name.
    
    Parameters:
    
    skippedItemNames - a Collection of case-insensitive item names, or null to not exclude any items
    
    Returns:
    
    this serializer
  - includeItems
```
JsonSerializer includeItems(Collection<String> includedItemNames)
```
    Include only specific items by name.
    Note: excludeItems(java.util.Collection<java.lang.String>) is still applied if both are specified.
    
    Parameters:
    
    includedItemNames - a Collection of case-insensitive item names, or null to not include only specific items
    
    Returns:
    
    this serializer
  - excludeTypes
```
JsonSerializer excludeTypes(Collection<ItemDataType> excludedTypes)
```
    Exclude item types.
    
    Parameters:
    
    excludedTypes - a Collection of item types to exclude, or null to not exclude any item types
    
    Returns:
    
    this serializer
  - lowercaseProperties
```
JsonSerializer lowercaseProperties(boolean lowercaseProperties)
```
    Sets whether property names in the emitted JSON should be lowercased. When false (the default), emitted properties will match the capitalization of the first of each named item in the source document.
    
    Parameters:
    
    lowercaseProperties - whether to lowercase property names
    
    Returns:
    
    this serializer
  - includeMetadata
```
JsonSerializer includeMetadata(boolean includeMetadata)
```
    Sets whether to include a metadata object in the output JSON, using the "@meta" property. false by default.
    
    Parameters:
    
    includeMetadata - whether to include a document-metadata object
    
    Returns:
    
    this serializer
  - booleanItemNames
```
JsonSerializer booleanItemNames(Collection<String> booleanItemNames)
```
    Sets the item names that should be considered boolean values when serialized to JSON.
    Items of type TEXT, NUMBER, and RFC822_TEXT, as well as single-value items of type TEXT_LIST or NUMBER_RANGE are evaluated for boolean conversion.
    
    Parameters:
    
    booleanItemNames - the names of items to serialize as boolean
    
    Returns:
    
    this serializer
  - booleanTrueValues
```
JsonSerializer booleanTrueValues(Collection<Object> trueValues)
```
    Sets the values used to determine true and false when serializing items configured via booleanItemNames(Collection).
    All values not specified here will be considered false.
    
    Parameters:
    
    trueValues - a collection of objects to compare to resolve as true
    
    Returns:
    
    this serializer
  - dateRangeFormat
```
JsonSerializer dateRangeFormat(DateRangeFormat format)
```
    Sets the format for date/time range values.
    
    Parameters:
    
    format - the DateRangeFormat type to use
    
    Returns:
    
    this serializer
  - toJson
```
Object toJson(Document doc)
```
    Serializes the provided document as a JSON object using the implementation's native JSON type.
    
    Parameters:
    
    doc - the document to serialize
    
    Returns:
    
    an implementation-dependent JSON object
  - toJsonString
```
default String toJsonString(Document doc)
```
    Serializes the provided document as a JSON string.
    
    Parameters:
    
    doc - the document to serialize
    
    Returns:
    
    a string of JSON content

Interface JsonSerializer

Field Summary

Method Summary

Field Detail

DEFAULT_EXCLUDED_ITEMS

PROP_METADATA

PROP_META_NOTEID

PROP_META_UNID

PROP_META_CREATED

PROP_META_LASTMODIFIED

PROP_META_LASTMODIFIEDINFILE

PROP_META_LASTACCESSED

PROP_META_ADDEDTOFILE

PROP_META_NOTECLASS

PROP_RANGE_FROM

PROP_RANGE_TO

Method Detail

createSerializer

excludeItems

includeItems

excludeTypes

lowercaseProperties

includeMetadata

booleanItemNames

booleanTrueValues

dateRangeFormat

toJson

toJsonString