com.pi4j.context.ContextProperties Maven / Gradle / Ivy

Go to download
package com.pi4j.context;

/*-
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: Java Library (CORE)
 * FILENAME      :  ContextProperties.java
 *
 * This file is part of the Pi4J project. More information about
 * this project can be found here:  https://pi4j.com/
 * **********************************************************************
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import com.pi4j.common.Describable;
import com.pi4j.common.Descriptor;
import com.pi4j.util.StringUtil;

import java.util.Map;

/**
 * ContextProperties interface.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public interface ContextProperties extends Describable {

    /**
     * has.
     *
     * @param key a {@link java.lang.String} object.
     * @return a boolean.
     */
    boolean has(String key);
    /**
     * get.
     *
     * @param key a {@link java.lang.String} object.
     * @return a {@link java.lang.String} object.
     */
    String get(String key);

    /**
     * all.
     *
     * @return a {@link java.util.Map} object.
     */
    Map all();
    /**
     * count.
     *
     * @return a int.
     */
    int count();

    /**
     * get.
     *
     * @param key a {@link java.lang.String} object.
     * @param defaultValue a {@link java.lang.String} object.
     * @return a {@link java.lang.String} object.
     */
    default String get(String key, String defaultValue){
        String value = get(key);
        if(StringUtil.isNotNullOrEmpty(value)) {
            return value;
        }
        return defaultValue;
    }

    /**
     * exists.
     *
     * @param key a {@link java.lang.String} object.
     * @return a boolean.
     */
    default boolean exists(String key){
        return has(key);
    }

    /**
     * getInteger.
     *
     * @param key a {@link java.lang.String} object.
     * @return a {@link java.lang.Integer} object.
     */
    default Integer getInteger(String key){
        return getInteger(key, null);
    }

    /**
     * getInteger.
     *
     * @param key a {@link java.lang.String} object.
     * @param defaultValue a {@link java.lang.Integer} object.
     * @return a {@link java.lang.Integer} object.
     */
    default Integer getInteger(String key, Integer defaultValue){
        if(has(key)) return StringUtil.parseInteger(get(key), defaultValue);
        return defaultValue;
    }

    /**
     * describe.
     *
     * @return a {@link com.pi4j.common.Descriptor} object.
     */
    default Descriptor describe() {
        Descriptor descriptor = Descriptor.create()
                .category("PROPERTIES")
                .name("Properties")
                .quantity(this.count())
                .type(this.getClass());

        for(Map.Entry e : this.all().entrySet()){
            descriptor.add(
            Descriptor.create()
                    .name(e.getKey().toString())
                    .category("PROPERTY")
                    .description(e.getValue().toString())
            );
        }
        return descriptor;
    }
}