org.ujorm.tools.web.ao

Interface HttpParameter

All Superinterfaces:

CharSequence

All Known Implementing Classes:

DefaultHttpParam

public interface HttpParameter
extends CharSequence

An interface for bulding HTML parameters by an Enumerator.

Usage

 {
    String value = Param.text(httpServletRequest, "my default value");
 }
 enum Param implements HttpParam {
     REGEXP,
     TEXT;

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMPTY_VALUE An empty text value

Method Summary

Modifier and Type	Method and Description
default @NotNull String	buildParameterName(@Nullable String name) Build a default non-null parameter name.
default @NotNull String	defaultValue() Returns a non-null default text value.
default char	charAt(int index)
default int	length()
default @NotNull String	of(@NotNull javax.servlet.ServletRequest request) Default value is an empty String
default boolean	of(@NotNull javax.servlet.ServletRequest request, @Nullable boolean defaultValue) Returns a parameter of the request or the default value
default <V extends Enum<V>> V	of(@NotNull javax.servlet.ServletRequest request, @NotNull Class<V> clazz) Returns a parameter of the request or the default value
default double	of(@NotNull javax.servlet.ServletRequest request, @Nullable double defaultValue) Returns a parameter of the request or the default value
default float	of(@NotNull javax.servlet.ServletRequest request, @Nullable float defaultValue) Returns a parameter of the request or the default value
default char	of(@NotNull javax.servlet.ServletRequest request, @Nullable char defaultValue) Returns a parameter of the request or the default value
default int	of(@NotNull javax.servlet.ServletRequest request, @Nullable int defaultValue) Returns a parameter of the request or the default value
default long	of(@NotNull javax.servlet.ServletRequest request, @Nullable long defaultValue) Returns a parameter of the request or the default value
default short	of(@NotNull javax.servlet.ServletRequest request, @Nullable short defaultValue) Returns a parameter of the request or the default value
default @NotNull String	of(@NotNull javax.servlet.ServletRequest request, @NotNull String defaultValue) Returns the last parameter value of the request or a default value
default <V extends Enum<V>> V	of(@NotNull javax.servlet.ServletRequest request, V defaultValue) Returns a parameter of the request or the Enum class
default <V> V	of(@NotNull javax.servlet.ServletRequest request, V defaultValue, @NotNull Function<String,V> decoder) Returns a parameter of the request or the default value
static HttpParameter	of(@NotNull String name) Create a default implementation
static HttpParameter	of(@NotNull String name, @NotNull String defaultValue) Create a default implementation
default @NotNull String	originalName() Get a raw name of the HTTP parameter.
default CharSequence	subSequence(int start, int end)
@NotNull String	toString() Returns a parameter name

Methods inherited from interface java.lang.CharSequence

codePoints, chars

Field Detail

EMPTY_VALUE

static final String EMPTY_VALUE

An empty text value

See Also:

Constant Field Values

Method Detail

toString

@NotNull
@NotNull String toString()

Returns a parameter name

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

length

default int length()

Specified by:

length in interface CharSequence

charAt

default char charAt(int index)

Specified by:

charAt in interface CharSequence

subSequence

default CharSequence subSequence(int start,
                                 int end)

Specified by:

subSequence in interface CharSequence

defaultValue

@NotNull
default @NotNull String defaultValue()

Returns a non-null default text value. The standard value is an empty String, override it for a change.

buildParameterName

@NotNull
default @NotNull String buildParameterName(@Nullable
                                                    @Nullable String name)

Build a default non-null parameter name.

originalName

@NotNull
default @NotNull String originalName()

Get a raw name of the HTTP parameter. The method can be called from the buildParameterName(java.lang.String) method. NOTE: The method was renamed from obsolete name() due a Kotlin compatibility.

of

@NotNull
default @NotNull String of(@NotNull
                                    @NotNull javax.servlet.ServletRequest request)

Default value is an empty String

of

@NotNull
default @NotNull String of(@NotNull
                                    @NotNull javax.servlet.ServletRequest request,
                                    @NotNull
                                    @NotNull String defaultValue)

Returns the last parameter value of the request or a default value

of

default boolean of(@NotNull
                   @NotNull javax.servlet.ServletRequest request,
                   @Nullable
                   @Nullable boolean defaultValue)

Returns a parameter of the request or the default value

of

default char of(@NotNull
                @NotNull javax.servlet.ServletRequest request,
                @Nullable
                @Nullable char defaultValue)

Returns a parameter of the request or the default value

of

default short of(@NotNull
                 @NotNull javax.servlet.ServletRequest request,
                 @Nullable
                 @Nullable short defaultValue)

Returns a parameter of the request or the default value

of

default int of(@NotNull
               @NotNull javax.servlet.ServletRequest request,
               @Nullable
               @Nullable int defaultValue)

Returns a parameter of the request or the default value

of

default long of(@NotNull
                @NotNull javax.servlet.ServletRequest request,
                @Nullable
                @Nullable long defaultValue)

Returns a parameter of the request or the default value

of

default float of(@NotNull
                 @NotNull javax.servlet.ServletRequest request,
                 @Nullable
                 @Nullable float defaultValue)

Returns a parameter of the request or the default value

of

default double of(@NotNull
                  @NotNull javax.servlet.ServletRequest request,
                  @Nullable
                  @Nullable double defaultValue)

Returns a parameter of the request or the default value

of

@NotNull
default <V extends Enum<V>> V of(@NotNull
                                          @NotNull javax.servlet.ServletRequest request,
                                          @NotNull
                                          V defaultValue)

Returns a parameter of the request or the Enum class

of

@Nullable
default <V extends Enum<V>> V of(@NotNull
                                           @NotNull javax.servlet.ServletRequest request,
                                           @NotNull
                                           @NotNull Class<V> clazz)

Returns a parameter of the request or the default value

of

default <V> V of(@NotNull
                 @NotNull javax.servlet.ServletRequest request,
                 @NotNull
                 V defaultValue,
                 @NotNull
                 @NotNull Function<String,V> decoder)

Returns a parameter of the request or the default value

of

static HttpParameter of(@NotNull
                        @NotNull String name)

Create a default implementation

of

static HttpParameter of(@NotNull
                        @NotNull String name,
                        @NotNull
                        @NotNull String defaultValue)

Create a default implementation