Top Description Inners Fields Constructors Methods

org.apache.avro

public abstract Class JsonProperties

Class Inheritance

extends Object

java.lang.Object
org.apache.avro.JsonProperties

Known Direct Subclasses

org.apache.avro.Protocol, org.apache.avro.Protocol.Message, org.apache.avro.Schema, org.apache.avro.Schema.Field

Imports

java.util.AbstractSet, .Collections, .Iterator, .LinkedHashMap, .Map, .Map.Entry, .Queue, .Set, java.util.concurrent.ConcurrentHashMap, .ConcurrentLinkedQueue, .ConcurrentMap, java.io.IOException, org.apache.avro.util.internal.Accessor, .Accessor.JsonPropertiesAccessor, .JacksonUtils, org.apache.avro.util.MapEntry, com.fasterxml.jackson.core.JsonGenerator, com.fasterxml.jackson.databind.JsonNode, com.fasterxml.jackson.databind.node.TextNode

Base class for objects that have JSON-valued properties. Avro and JSON values are represented in Java using the following mapping:

	Avro type	JSON type	Java type
`null`	`null`	`NULL_VALUE`
`boolean`	Boolean	`boolean`
`int`	Number	`int`
`long`	Number	`long`
`float`	Number	`float`
`double`	Number	`double`
`bytes`	String	`byte[]`
`string`	String	`java.lang.String`
`record`	Object	`java.util.Map`
`enum`	String	`java.lang.String`
`array`	Array	`java.util.Collection`
`map`	Object	`java.util.Map`
`fixed`	String	`byte[]`

See Also: org.apache.avro.data.Json

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	JsonProperties.Null

Field Summary

Modifier and Type	Field and Description
public static final JsonProperties.Null	NULL_VALUE A value representing a JSON `null`.
private ConcurrentMap<String, JsonNode>	props
private Set<String>	reserved

Constructor Summary

Access	Constructor and Description
pack-priv	JsonProperties(Set<String> reserved)
pack-priv	JsonProperties(Set<String> reserved, Map<String, ?> propMap)

Method Summary

Modifier and Type	Method and Description
public void	addAllProps(JsonProperties properties) Adds all the props from the specified json properties.
public void	addProp(String The name of the property to add name, String The value for the property to add value) Adds a property with the given name `name` and value `value`.
public void	addProp(String name, Object value)
private void	addProp(String The name of the property to add name, JsonNode The value for the property to add value) Adds a property with the given name `name` and value `value`.
private JsonNode	getJsonProp(String name) Returns the value of the named property in this schema.
public Object	getObjectProp(String name) Returns the value of the named property in this schema.
public Map<String, Object>	getObjectProps() Return the defined properties as an unmodifiable Map.
public String	getProp(String name) Returns the value of the named, string-valued property in this schema.
public boolean	hasProps()
pack-priv boolean	propsEqual(JsonProperties np)
pack-priv int	propsHashCode()
public void	putAll(JsonProperties np)
pack-priv void	writeProps(JsonGenerator gen)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

NULL_VALUE	back to summary
public static final JsonProperties.Null NULL_VALUE A value representing a JSON `null`.

props	back to summary
private ConcurrentMap<String, JsonNode> props

reserved	back to summary
private Set<String> reserved

Constructor Detail

JsonProperties	back to summary
pack-priv JsonProperties(Set<String> reserved)

JsonProperties	back to summary
pack-priv JsonProperties(Set<String> reserved, Map<String, ?> propMap)

Method Detail

addAllProps back to summary

addAllProps	back to summary
public void addAllProps(JsonProperties properties) Adds all the props from the specified json properties. See Also `getObjectProps()`

public void addAllProps(JsonProperties properties)

Adds all the props from the specified json properties.

See Also: getObjectProps()

addProp back to summary

addProp	back to summary
public void addProp(String name, String value) Adds a property with the given name `name` and value `value`. Neither `name` nor `value` can be `null`. It is illegal to add a property if another with the same name but different value already exists in this schema. Parameters name:String The name of the property to add value:String The value for the property to add

public void addProp(String name, String value)

Adds a property with the given name name and value value. Neither name nor value can be null. It is illegal to add a property if another with the same name but different value already exists in this schema.

Parameters

name:String: The name of the property to add
value:String: The value for the property to add

addProp	back to summary
public void addProp(String name, Object value)