package com.temp.client.foundation.pavment;

import java.util.List;

import com.google.gwt.place.shared.Place;

/**
 * Token encoding and packing support for the Right part of the GWT History URL
 * Fragment
 *
 * @author georgs
 */
public abstract class AbstractPlaceTokenizer<T extends Place> extends IdTokenizer<T> {

    protected AbstractPlaceTokenizer(Object pPlaceId) {
        super(pPlaceId);
    }

    /**
     * Encode the passed Strings into a single String.
     *
     * @return "" if null passed OR no strings, individual nulls treated as ""
     */
    protected String encode(String... strings) {
        return encodePacked(PlaceTokenPackaging.pack(strings));
    }

    /**
     * Encode the passed Strings into a single String.
     *
     * @return "" if null passed OR no strings, individual nulls treated as ""
     */
    protected String encode(List<String> strings) {
        return encodePacked(PlaceTokenPackaging.pack(strings));
    }

    /**
     * Decode the passed String into multiple Strings.
     *
     * @return empty if "" or null passed OR the data can not be unpacked,
     *         otherwise the list will be at least one string and no entries
     *         will be null
     */
    protected List<String> decode(String encoded) {
        return decode(encoded, 0);
    }

    /**
     * Decode the passed String into multiple Strings.
     *
     * @return empty if minimumListSize < 1 AND (null or "" passed, OR the data
     *         can not be unpacked) otherwise the list will be at least
     *         minimumListSize (or 1 if minimumListSize < 1) and no entries will
     *         be null.
     */
    protected static List<String> decode(String encoded, int minimumListSize) {
        return PlaceTokenPackaging.unpack(PlaceTokenCodecRegistry.decode(encoded), minimumListSize);
    }

    private String encodePacked(String packed) {
        return PlaceTokenCodecRegistry.encode(packed);
    }

    protected String toString(Object object) {
        return (object != null) ? object.toString() : null;
    }
}