com.pi4j.common.Metadatum Maven / Gradle / Ivy

Go to download
package com.pi4j.common;

/*-
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: Java Library (CORE)
 * FILENAME      :  Metadatum.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.impl.MetadatumImpl;

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

    /**
     * key.
     *
     * @param key a {@link java.lang.String} object.
     * @return a {@link com.pi4j.common.Metadatum} object.
     */
    Metadatum key(String key);
    /**
     * value.
     *
     * @param value a {@link java.lang.Object} object.
     * @return a {@link com.pi4j.common.Metadatum} object.
     */
    Metadatum value(Object value);
    /**
     * description.
     *
     * @param description a {@link java.lang.String} object.
     * @return a {@link com.pi4j.common.Metadatum} object.
     */
    Metadatum description(String description);
    /**
     * key.
     *
     * @return a {@link java.lang.String} object.
     */
    String key();
    /**
     * value.
     *
     * @return a {@link java.lang.Object} object.
     */
    Object value();
    /**
     * description.
     *
     * @return a {@link java.lang.String} object.
     */
    String description();

    /**
     * create.
     *
     * @return a {@link com.pi4j.common.Metadatum} object.
     */
    static Metadatum create(){
        return new MetadatumImpl();
    }

    /**
     * create.
     *
     * @param key a {@link java.lang.String} object.
     * @return a {@link com.pi4j.common.Metadatum} object.
     */
    static Metadatum create(String key){
        return create().key(key);
    }

    /**
     * create.
     *
     * @param key a {@link java.lang.String} object.
     * @param value a {@link java.lang.Object} object.
     * @return a {@link com.pi4j.common.Metadatum} object.
     */
    static Metadatum create(String key, Object value){
        return create(key).value(value);
    }

    /**
     * create.
     *
     * @param key a {@link java.lang.String} object.
     * @param value a {@link java.lang.Object} object.
     * @param description a {@link java.lang.String} object.
     * @return a {@link com.pi4j.common.Metadatum} object.
     */
    static Metadatum create(String key, Object value, String description){
        return create(key, value).description(description);
    }

    /** {@inheritDoc} */
    @Override
    default Descriptor describe() {
        return Descriptor.create().name(key()).description(description()).value(value());
    }
}