org.apache.flink.runtime.webmonitor.handlers

Class StringQueryParameter

java.lang.Object

org.apache.flink.runtime.rest.messages.MessageParameter<List<X>>

org.apache.flink.runtime.rest.messages.MessageQueryParameter<String>

org.apache.flink.runtime.webmonitor.handlers.StringQueryParameter

Direct Known Subclasses:

EntryClassQueryParameter, ProgramArgQueryParameter, ProgramArgsQueryParameter, SavepointPathQueryParameter

public abstract class StringQueryParameter
extends MessageQueryParameter<String>

Abstract super class for String query parameters.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.runtime.rest.messages.MessageParameter

MessageParameter.MessageParameterRequisiteness

Constructor Summary

Constructors

Constructor and Description
StringQueryParameter(String key, MessageParameter.MessageParameterRequisiteness requisiteness)

Method Summary

Modifier and Type	Method and Description
String	convertStringToValue(String value) Converts the given string to a valid value of this parameter.
String	convertValueToString(String value) Converts the given value to its string representation.

Methods inherited from class org.apache.flink.runtime.rest.messages.MessageQueryParameter

convertFromString, convertToString

Methods inherited from class org.apache.flink.runtime.rest.messages.MessageParameter

getDescription, getKey, getValue, isMandatory, isResolved, resolve, resolveFromString

Methods inherited from class java.lang.Object

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

Constructor Detail

StringQueryParameter

public StringQueryParameter(String key,
                            MessageParameter.MessageParameterRequisiteness requisiteness)

Method Detail

convertStringToValue

public final String convertStringToValue(String value)

Description copied from class: MessageQueryParameter

Converts the given string to a valid value of this parameter.

Specified by:

convertStringToValue in class MessageQueryParameter<String>

Parameters:

value - string representation of parameter value

Returns:

parameter value

convertValueToString

public final String convertValueToString(String value)

Description copied from class: MessageQueryParameter

Converts the given value to its string representation.

Specified by:

convertValueToString in class MessageQueryParameter<String>

Parameters:

value - parameter value

Returns:

string representation of typed value