org.incode.example.settings.dom.Setting Maven / Gradle / Ivy

Go to download
package org.incode.example.settings.dom;

import org.joda.time.LocalDate;


/**
 * Common supertype for both {@link ApplicationSetting} and {@link UserSetting}.
 * 
 * 
 * The difference between the two is in the settings unique identifier; 
 * the former just is uniquely identified by a single key (defined in 
 * {@link #getKey() this interface}, whereas the latter is uniquely identified by
 * the combination of the key plus an identifier of the user.
 */
public interface Setting {

    /**
     * In the case of {@link ApplicationSetting}, this constitutes the unique identifier;
     * for a {@link UserSetting}, the unique identifier is both this key plus an identifier
     * for the user.  
     */
    String getKey();

    SettingType getType();
    String getDescription();

    String getValueRaw();

    String valueAsString();
    LocalDate valueAsLocalDate();
    Integer valueAsInt();
    Long valueAsLong();
    Boolean valueAsBoolean();
    
}