Class S2TaggedShapeCoder

java.lang.Object

com.google.common.geometry.S2TaggedShapeCoder

All Implemented Interfaces:

S2Coder<S2Shape>

@GwtIncompatible("S2LaxPolylineShape and S2LaxPolygonShape")
public class S2TaggedShapeCoder
extends Object
implements S2Coder<S2Shape>

An encoder/decoder of tagged S2Shapes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	S2TaggedShapeCoder.Builder	A builder for creating S2TaggedShapeCoder instances.

Field Summary

Fields

Modifier and Type	Field	Description
static final S2TaggedShapeCoder	COMPACT	An instance of a S2TaggedShapeCoder which encodes/decodes S2Shapes in the COMPACT encoding format.
static final S2TaggedShapeCoder	FAST	An instance of a S2TaggedShapeCoder which encodes/decodes S2Shapes in the FAST encoding format.

Method Summary

Modifier and Type	Method	Description
static S2TaggedShapeCoder.Builder	builder()	Returns a new S2TaggedShapeCoder.Builder.
S2Shape	decode(PrimitiveArrays.Bytes data, PrimitiveArrays.Cursor cursor)	Decodes a value of type T from data starting at cursor.position.
void	encode(S2Shape value, OutputStream output)	Encodes value to output.
S2TaggedShapeCoder.Builder	toBuilder()	Returns a new S2TaggedShapeCoder.Builder initialized with the current S2TaggedShapeCoder.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FAST

public static final S2TaggedShapeCoder FAST

An instance of a S2TaggedShapeCoder which encodes/decodes S2Shapes in the FAST encoding format. The FAST format is optimized for fast encoding/decoding.

COMPACT

public static final S2TaggedShapeCoder COMPACT

An instance of a S2TaggedShapeCoder which encodes/decodes S2Shapes in the COMPACT encoding format. The COMPACT format is optimized for disk usage and memory footprint.

Method Details

encode

public void encode(S2Shape value,
 OutputStream output)
            throws IOException

Description copied from interface: S2Coder

Encodes value to output.

Specified by:

encode in interface S2Coder<S2Shape>

Throws:

IOException

decode

public S2Shape decode(PrimitiveArrays.Bytes data,
 PrimitiveArrays.Cursor cursor)

Description copied from interface: S2Coder

Decodes a value of type T from data starting at cursor.position. cursor.position is updated to the position of the first byte in data following the encoded value.

Specified by:

decode in interface S2Coder<S2Shape>

builder

public static S2TaggedShapeCoder.Builder builder()

Returns a new S2TaggedShapeCoder.Builder.

toBuilder

public S2TaggedShapeCoder.Builder toBuilder()

Returns a new S2TaggedShapeCoder.Builder initialized with the current S2TaggedShapeCoder.