package com.temp.foundation.client.pavment;

/**
 * Implementations support different "Flavors" of Encoding a Place's Data (token
 * - The Right part, after the ':', of the URL Fragment; What GWT uses for
 * History)
 *
 * @author georgs
 */
public interface PlaceTokenCodec {
    /**
     * Encode the String (nulls are returned as "")
     *
     * @return nulls are returned as "", otherwise the Encoded String.
     */
    public String encode( String unencoded );

    /**
     * Decode the previously "encoded" data, null or bad encoding will return
     * null.
     *
     * @return null indicates that the data was either null or contained
     * unacceptable characters for decoding.
     */
    public String decode( String encoded );
}