Module org.github.gestalt.core

Package org.github.gestalt.config.decoder

Class StringConstructorDecoder

java.lang.Object

org.github.gestalt.config.decoder.StringConstructorDecoder

All Implemented Interfaces:

Decoder<java.lang.Object>

public final class StringConstructorDecoder
extends java.lang.Object
implements Decoder<java.lang.Object>

Decode a String.

Constructor Summary

Constructors

Constructor	Description
StringConstructorDecoder()

Method Summary

Modifier and Type	Method	Description
boolean	canDecode(java.lang.String path, Tags tags, ConfigNode node, TypeCapture<?> type)	true if this decoder matches the type capture.
GResultOf<java.lang.Object>	decode(java.lang.String path, Tags tags, ConfigNode node, TypeCapture<?> type, DecoderContext decoderContext)	Decode the current node.
java.lang.String	name()	Name of the encoder.
Priority	priority()	Priority for the decoder.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.github.gestalt.config.decoder.Decoder

applyConfig

Constructor Detail

StringConstructorDecoder

public StringConstructorDecoder()

Method Detail

priority

public Priority priority()

Description copied from interface: Decoder

Priority for the decoder. Allows us to sort encoders when we have multiple matches.

Specified by:

priority in interface Decoder<java.lang.Object>

Returns:

Priority

name

public java.lang.String name()

Description copied from interface: Decoder

Name of the encoder.

Specified by:

name in interface Decoder<java.lang.Object>

Returns:

encoder name

canDecode

public boolean canDecode(java.lang.String path,
                         Tags tags,
                         ConfigNode node,
                         TypeCapture<?> type)

Description copied from interface: Decoder

true if this decoder matches the type capture.

Specified by:

canDecode in interface Decoder<java.lang.Object>

Parameters:

path - the current path

tags - the tags for the current request

node - the current node we are decoding.

type - the type of object we are decoding.

Returns:

true if this decoder matches the type capture

decode

public GResultOf<java.lang.Object> decode(java.lang.String path,
                                          Tags tags,
                                          ConfigNode node,
                                          TypeCapture<?> type,
                                          DecoderContext decoderContext)

Decode the current node. If the current node is a class or list we may need to decode sub nodes.

Specified by:

decode in interface Decoder<java.lang.Object>

Parameters:

path - the current path

tags - the tags for the current request

node - the current node we are decoding.

type - the type of object we are decoding.

decoderContext - The context of the current decoder.

Returns:

GResultOf the current node with details of either success or failures.