Package net.solarnetwork.codec

Enum Class BasicLocationField

java.lang.Object

java.lang.Enum<BasicLocationField>

net.solarnetwork.codec.BasicLocationField

All Implemented Interfaces:

Serializable, Comparable<BasicLocationField>, Constable, IndexedField

public enum BasicLocationField
extends Enum<BasicLocationField>
implements IndexedField

Fields for BasicLocation.

Since:

1.72

Version:

1.1

Author:

matt

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Country	The country.
Elevation	The elevation.
Latitude	The latitude.
Locality	The locality.
Longitude	The longitude.
Name	The name.
PostalCode	The postal code.
Region	The region.
StateOrProvince	The state or province.
Street	The street.
TimeZoneId	The time zone ID.

Field Summary

Fields

Modifier and Type	Field	Description
static final Map<String,BasicLocationField>	FIELD_MAP	A field map.

Method Summary

Modifier and Type	Method	Description
String	getFieldName()	Get the field name.
int	getIndex()	Get the index.
Object	parseValue(com.fasterxml.jackson.core.JsonParser parser, com.fasterxml.jackson.databind.DeserializationContext ctxt)	Parse a value from a parser.
static BasicLocationField	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BasicLocationField[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
void	writeValue(com.fasterxml.jackson.core.JsonGenerator generator, com.fasterxml.jackson.databind.SerializerProvider provider, Object value)	Write a value to a generator.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Name

public static final BasicLocationField Name

The name.

Country

public static final BasicLocationField Country

The country.

Region

public static final BasicLocationField Region

The region.

StateOrProvince

public static final BasicLocationField StateOrProvince

The state or province.

PostalCode

public static final BasicLocationField PostalCode

The postal code.

Locality

public static final BasicLocationField Locality

The locality.

Street

public static final BasicLocationField Street

The street.

Latitude

public static final BasicLocationField Latitude

The latitude.

Longitude

public static final BasicLocationField Longitude

The longitude.

Elevation

public static final BasicLocationField Elevation

The elevation.

TimeZoneId

public static final BasicLocationField TimeZoneId

The time zone ID.

Field Details

FIELD_MAP

public static final Map<String,BasicLocationField> FIELD_MAP

A field map.

Method Details

values

public static BasicLocationField[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static BasicLocationField valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getIndex

public int getIndex()

Description copied from interface: IndexedField

Get the index.

Specified by:

getIndex in interface IndexedField

Returns:

the index

getFieldName

public String getFieldName()

Description copied from interface: IndexedField

Get the field name.

Specified by:

getFieldName in interface IndexedField

Returns:

the fieldName

parseValue

public Object parseValue(com.fasterxml.jackson.core.JsonParser parser,
 com.fasterxml.jackson.databind.DeserializationContext ctxt)
                  throws IOException,
com.fasterxml.jackson.core.JsonProcessingException

Description copied from interface: IndexedField

Parse a value from a parser.

Specified by:

parseValue in interface IndexedField

Parameters:

parser - the parser

ctxt - the context

Returns:

the parsed object

Throws:

IOException - if any IO error occurs

com.fasterxml.jackson.core.JsonProcessingException - if any JSON processing error occurs

writeValue

public void writeValue(com.fasterxml.jackson.core.JsonGenerator generator,
 com.fasterxml.jackson.databind.SerializerProvider provider,
 Object value)
                throws IOException,
com.fasterxml.jackson.core.JsonProcessingException

Description copied from interface: IndexedField

Write a value to a generator.

Specified by:

writeValue in interface IndexedField

Parameters:

generator - the generator

provider - the provider

value - the value to write

Throws:

IOException - if any IO error occurs

com.fasterxml.jackson.core.JsonProcessingException - if any JSON processing error occurs