Module org.refcodes.web
Package org.refcodes.web

Class RequestCookie

java.lang.Object
org.refcodes.struct.RelationImpl<String,String>
org.refcodes.struct.PropertyImpl
org.refcodes.struct.PropertyImpl.PropertyBuilderImpl
org.refcodes.web.RequestCookie
All Implemented Interfaces:
org.refcodes.mixin.KeyAccessor<String>, org.refcodes.mixin.KeyAccessor.KeyBuilder<String,org.refcodes.struct.Relation.RelationBuilder<String,String>>, org.refcodes.mixin.KeyAccessor.KeyMutator<String>, org.refcodes.mixin.KeyAccessor.KeyProperty<String>, org.refcodes.mixin.ValueAccessor<String>, org.refcodes.mixin.ValueAccessor.ValueBuilder<String,org.refcodes.struct.Relation.RelationBuilder<String,String>>, org.refcodes.mixin.ValueAccessor.ValueMutator<String>, org.refcodes.mixin.ValueAccessor.ValueProperty<String>, org.refcodes.struct.Property, org.refcodes.struct.Property.PropertyBuilder, org.refcodes.struct.Relation<String,String>, org.refcodes.struct.Relation.RelationBuilder<String,String>, Cookie
public class RequestCookie extends org.refcodes.struct.PropertyImpl.PropertyBuilderImpl implements Cookie
The RequestCookie represents a request cookies: We use URL encoding / decoding for the cookie value (regarding fromHttpCookie(String) and toHttpCookie()) to make life easier and not fall into the trap of unescaped values.

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.refcodes.struct.PropertyImpl

    org.refcodes.struct.PropertyImpl.PropertyBuilderImpl

    Nested classes/interfaces inherited from class org.refcodes.struct.RelationImpl

    org.refcodes.struct.RelationImpl.RelationBuilderImpl<K extends Object,V extends Object>

    Nested classes/interfaces inherited from interface org.refcodes.mixin.KeyAccessor

    org.refcodes.mixin.KeyAccessor.KeyBuilder<K extends Object,B extends org.refcodes.mixin.KeyAccessor.KeyBuilder<K,B>>, org.refcodes.mixin.KeyAccessor.KeyMutator<K extends Object>, org.refcodes.mixin.KeyAccessor.KeyProperty<K extends Object>

    Nested classes/interfaces inherited from interface org.refcodes.struct.Property

    org.refcodes.struct.Property.PropertyBuilder

    Nested classes/interfaces inherited from interface org.refcodes.struct.Relation

    org.refcodes.struct.Relation.RelationBuilder<K extends Object,V extends Object>

    Nested classes/interfaces inherited from interface org.refcodes.mixin.ValueAccessor

    org.refcodes.mixin.ValueAccessor.ValueBuilder<V extends Object,B extends org.refcodes.mixin.ValueAccessor.ValueBuilder<V,B>>, org.refcodes.mixin.ValueAccessor.ValueMutator<V extends Object>, org.refcodes.mixin.ValueAccessor.ValueProperty<V extends Object>

  • Field Summary

    Fields inherited from class org.refcodes.struct.RelationImpl

    _key, _value

  • Constructor Summary

    Constructors
    Constructor
    Description
    RequestCookie()
    Constructs a RequestCookie.
    RequestCookie(String aHttpCookie)
    Constructs a RequestCookie.
    RequestCookie(String aCookieName, String aValue)
    Constructs a RequestCookie with the given cookie name and value.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    fromHttpCookie(String aHttpCookie)
    Sets the cookie according to the provided HTTP cookie text.
    String
    toHttpCookie()
    Returns the cookie to be assigned to a cookie Header-Field.
    String
    toString()
    RequestCookie
    withHttpCookie(String aCookie)
    Sets the cookie according to the provided HTTP cookie text via Cookie.fromHttpCookie(String).

    Methods inherited from class org.refcodes.struct.PropertyImpl.PropertyBuilderImpl

    setKey, setValue

    Methods inherited from class org.refcodes.struct.RelationImpl

    getKey, getValue

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.refcodes.mixin.KeyAccessor

    getKey

    Methods inherited from interface org.refcodes.mixin.KeyAccessor.KeyMutator

    setKey

    Methods inherited from interface org.refcodes.mixin.KeyAccessor.KeyProperty

    letKey

    Methods inherited from interface org.refcodes.struct.Property

    toProperty

    Methods inherited from interface org.refcodes.struct.Property.PropertyBuilder

    withKey, withValue

    Methods inherited from interface org.refcodes.mixin.ValueAccessor

    getValue, getValueOr

    Methods inherited from interface org.refcodes.mixin.ValueAccessor.ValueMutator

    setValue

    Methods inherited from interface org.refcodes.mixin.ValueAccessor.ValueProperty

    letValue

  • Constructor Details

    • RequestCookie

      public RequestCookie()
      Constructs a RequestCookie.

    • RequestCookie

      public RequestCookie(String aCookieName, String aValue)
      Constructs a RequestCookie with the given cookie name and value.
      Parameters:
      aCookieName - The name of the cookie.
      aValue - The value for the cookie.

    • RequestCookie

      public RequestCookie(String aHttpCookie)
      Constructs a RequestCookie.
      Parameters:
      aHttpCookie - The text as being found in the according HTTP header field.

  • Method Details

    • withHttpCookie

      public RequestCookie withHttpCookie(String aCookie)
      Sets the cookie according to the provided HTTP cookie text via Cookie.fromHttpCookie(String).
      Specified by:
      withHttpCookie in interface Cookie
      Parameters:
      aCookie - The HTTP cookie text.
      Returns:
      A Cookie instance as of the Builder-Pattern.

    • fromHttpCookie

      public void fromHttpCookie(String aHttpCookie)
      Sets the cookie according to the provided HTTP cookie text.
      Specified by:
      fromHttpCookie in interface Cookie
      Parameters:
      aHttpCookie - The HTTP cookie text.

    • toHttpCookie

      public String toHttpCookie()
      Returns the cookie to be assigned to a cookie Header-Field.
      Specified by:
      toHttpCookie in interface Cookie
      Returns:
      The cookie value for a Header-Field.

    • toString

      public String toString()
      Overrides:
      toString in class org.refcodes.struct.PropertyImpl.PropertyBuilderImpl