Package io.deephaven.protobuf

Class FieldOptions

java.lang.Object

io.deephaven.protobuf.FieldOptions

@Immutable
public abstract class FieldOptions
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FieldOptions.Builder
static interface	FieldOptions.BytesBehavior	The behavior when handling a protobuf bytes field.
static interface	FieldOptions.MapBehavior	The behavior when handling a protobuf map field.
static interface	FieldOptions.WellKnownBehavior	The behavior when handling a protobuf message type.

Constructor Summary

Constructors

Constructor	Description
FieldOptions()

Method Summary

Modifier and Type	Method	Description
static FieldOptions.Builder	builder()
FieldOptions.BytesBehavior	bytes()	The bytes type behavior.
static FieldOptions	defaults()	The defaults options.
static FieldOptions	exclude()	Creates the options to exclude a field.
boolean	include()	If the field should be included for parsing.
static Function<FieldPath,FieldOptions>	includeIf(Predicate<FieldPath> include)	Creates a field options function that maps the include predicate to include().
FieldOptions.MapBehavior	map()	The map type behavior.
FieldOptions.WellKnownBehavior	wellKnown()	The well-known message behavior.

Methods inherited from class java.lang.Object

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

Constructor Details

FieldOptions

public FieldOptions()

Method Details

builder

public static FieldOptions.Builder builder()

defaults

public static FieldOptions defaults()

The defaults options. Equivalent to builder().build().

Returns:

the default options

exclude

public static FieldOptions exclude()

Creates the options to exclude a field. Equivalent to builder().include(false).build().

Returns:

the options to exclude a field

includeIf

public static Function<FieldPath,FieldOptions> includeIf(Predicate<FieldPath> include)

Creates a field options function that maps the include predicate to include(). Equivalent to fp -> builder().include(include.test(fp)).build().

Parameters:

include - the include function

Returns:

the field path functions

include

@Default
public boolean include()

If the field should be included for parsing. By default, is true.

Returns:

if the field should be included

wellKnown

@Default
public FieldOptions.WellKnownBehavior wellKnown()

The well-known message behavior. By default, is FieldOptions.WellKnownBehavior.asWellKnown().

Returns:

the well-known message behavior

bytes

@Default
public FieldOptions.BytesBehavior bytes()

The bytes type behavior. By default, is FieldOptions.BytesBehavior.asByteArray().

Returns:

the bytes field behavior

map

@Default
public FieldOptions.MapBehavior map()

The map type behavior. By default, is FieldOptions.MapBehavior.asMap().

Returns:

the map field behavior.