88 строки
6.0 KiB
YAML
88 строки
6.0 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.cosmos.CosmosItemSerializer"
|
|
fullName: "com.azure.cosmos.CosmosItemSerializer"
|
|
name: "CosmosItemSerializer"
|
|
nameWithType: "CosmosItemSerializer"
|
|
summary: "The <xref uid=\"com.azure.cosmos.CosmosItemSerializer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosItemSerializer\"></xref> allows customizing the serialization of Cosmos Items - either to transform payload (for example wrap/unwrap in custom envelopes) or use custom serialization settings or json serializer stacks."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public abstract class **CosmosItemSerializer**"
|
|
constructors:
|
|
- uid: "com.azure.cosmos.CosmosItemSerializer.CosmosItemSerializer()"
|
|
fullName: "com.azure.cosmos.CosmosItemSerializer.CosmosItemSerializer()"
|
|
name: "CosmosItemSerializer()"
|
|
nameWithType: "CosmosItemSerializer.CosmosItemSerializer()"
|
|
summary: "Used to instantiate subclasses"
|
|
modifiers:
|
|
- "protected"
|
|
syntax: "protected CosmosItemSerializer()"
|
|
desc: "Used to instantiate subclasses"
|
|
fields:
|
|
- uid: "com.azure.cosmos.CosmosItemSerializer.DEFAULT_SERIALIZER"
|
|
fullName: "com.azure.cosmos.CosmosItemSerializer.DEFAULT_SERIALIZER"
|
|
name: "DEFAULT_SERIALIZER"
|
|
nameWithType: "CosmosItemSerializer.DEFAULT_SERIALIZER"
|
|
summary: "Gets the default Cosmos item serializer."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"com.azure.cosmos.CosmosItemSerializer?alt=com.azure.cosmos.CosmosItemSerializer&text=CosmosItemSerializer\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final CosmosItemSerializer DEFAULT_SERIALIZER"
|
|
desc: "Gets the default Cosmos item serializer. This serializer is used by default when no custom serializer is specified on request options or the <xref uid=\"com.azure.cosmos.CosmosClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosClientBuilder\"></xref>"
|
|
methods:
|
|
- uid: "com.azure.cosmos.CosmosItemSerializer.<T>deserialize(java.util.Map<java.lang.String,java.lang.Object>,java.lang.Class<T>)"
|
|
fullName: "com.azure.cosmos.CosmosItemSerializer.deserialize(Map<String,Object> jsonNodeMap, Class<T> classType)"
|
|
name: "deserialize(Map<String,Object> jsonNodeMap, Class<T> classType)"
|
|
nameWithType: "CosmosItemSerializer.deserialize(Map<String,Object> jsonNodeMap, Class<T> classType)"
|
|
summary: "Used to deserialize the json tree stored in the Cosmos DB item as a POJO"
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the json tree from the Cosmos DB item"
|
|
name: "jsonNodeMap"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>>"
|
|
- description: "The type of the POJO"
|
|
name: "classType"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html\">Class</a><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public abstract T <T>deserialize(Map<String,Object> jsonNodeMap, Class<T> classType)"
|
|
desc: "Used to deserialize the json tree stored in the Cosmos DB item as a POJO"
|
|
returns:
|
|
description: "The deserialized POJO"
|
|
type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.CosmosItemSerializer.<T>serialize(T)"
|
|
fullName: "com.azure.cosmos.CosmosItemSerializer.serialize(T item)"
|
|
name: "serialize(T item)"
|
|
nameWithType: "CosmosItemSerializer.serialize(T item)"
|
|
summary: "Used to serialize a POJO into a json tree"
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the POJO to be serialized"
|
|
name: "item"
|
|
type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Map<String,Object> <T>serialize(T item)"
|
|
desc: "Used to serialize a POJO into a json tree"
|
|
returns:
|
|
description: "the json tree that will be used as payload in Cosmos DB items"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>>"
|
|
type: "class"
|
|
desc: "The <xref uid=\"com.azure.cosmos.CosmosItemSerializer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosItemSerializer\"></xref> allows customizing the serialization of Cosmos Items - either to transform payload (for example wrap/unwrap in custom envelopes) or use custom serialization settings or json serializer stacks."
|
|
metadata: {}
|
|
package: "com.azure.cosmos"
|
|
artifact: com.azure:azure-cosmos:4.63.3
|