org.apache.avro

Class Schema.Field

java.lang.Object

org.apache.avro.JsonProperties

org.apache.avro.Schema.Field

Enclosing class:

Schema

public static class Schema.Field
extends JsonProperties

A field within a record.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Schema.Field.Order How values of this field should be ordered when sorting records.

Nested classes/interfaces inherited from class org.apache.avro.JsonProperties

JsonProperties.Null

Field Summary

Fields inherited from class org.apache.avro.JsonProperties

NULL_VALUE

Constructor Summary

Constructors

Constructor and Description
Schema.Field(String name, Schema schema, String doc, org.codehaus.jackson.JsonNode defaultValue)
Schema.Field(String name, Schema schema, String doc, org.codehaus.jackson.JsonNode defaultValue, Schema.Field.Order order)
Schema.Field(String name, Schema schema, String doc, Object defaultValue)
Schema.Field(String name, Schema schema, String doc, Object defaultValue, Schema.Field.Order order)

Method Summary

Methods

Modifier and Type	Method and Description
void	addAlias(String alias)
Set<String>	aliases() Return the defined aliases as an unmodifieable Set.
Object	defaultVal()
org.codehaus.jackson.JsonNode	defaultValue()
String	doc() Field's documentation within the record, if set.
boolean	equals(Object other)
int	hashCode()
String	name()
Schema.Field.Order	order()
int	pos() The position of this field within the record.
Map<String,String>	props() Deprecated.
Schema	schema() This field's Schema.
String	toString()

Methods inherited from class org.apache.avro.JsonProperties

addProp, addProp, addProp, getJsonProp, getJsonProps, getObjectProp, getObjectProps, getProp, getProps

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Schema.Field

public Schema.Field(String name,
            Schema schema,
            String doc,
            org.codehaus.jackson.JsonNode defaultValue)

Schema.Field

public Schema.Field(String name,
            Schema schema,
            String doc,
            org.codehaus.jackson.JsonNode defaultValue,
            Schema.Field.Order order)

Schema.Field

public Schema.Field(String name,
            Schema schema,
            String doc,
            Object defaultValue)

Parameters:

defaultValue - the default value for this field specified using the mapping in JsonProperties

Schema.Field

public Schema.Field(String name,
            Schema schema,
            String doc,
            Object defaultValue,
            Schema.Field.Order order)

Parameters:

defaultValue - the default value for this field specified using the mapping in JsonProperties

Method Detail

name

public String name()

pos

public int pos()

The position of this field within the record.

schema

public Schema schema()

This field's Schema.

doc

public String doc()

Field's documentation within the record, if set. May return null.

defaultValue

public org.codehaus.jackson.JsonNode defaultValue()

defaultVal

public Object defaultVal()

Returns:

the default value for this field specified using the mapping in JsonProperties

order

public Schema.Field.Order order()

props

@Deprecated
public Map<String,String> props()

Deprecated.

addAlias

public void addAlias(String alias)

aliases

public Set<String> aliases()

Return the defined aliases as an unmodifieable Set.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object