com.icthh.xm.commons.request.XmRequestContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xm-commons-request Show documentation

xm-commons-request

There is a newer version: 4.0.20

package com.icthh.xm.commons.request;

/**
 * Context holder for request-specific state, like current request data, current locale,
 * current theme, and potential binding errors.
 * 

 * Suitable in cases where Spring RequestContext doesn't meet the requirements of application.
 * For example, when application has no HttServletRequest or has not for all requests sources.
 */
public interface XmRequestContext {

    /**
     * Checks is key exist in current context.
     *
     * @param key the unique key of context value object
     * @return {@code true} if specified key exist in current context
     */
    boolean containsKey(String key);

    /**
     * Gets value from current context by key and cast it to specified type.
     *
     * @param key  the unique key of context value object
     * @param type the class type of the value
     * @param   type of the value
     * @return the value object associated with key
     */
     T getValue(String key, Class type);

    /**
     * Gets value from current context by key and cast it to specified type
     * or return default value if context value is {@code null}.
     *
     * @param key          the unique key of context value object
     * @param type         the class type of the value
     * @param defaultValue the default value to be returned if context value is {@code null}
     * @param           type of the value
     * @return the value object associated with key or default value if context value is {@code null}
     */
     T getValueOrDefault(String key, Class type, T defaultValue);

}