src/main/java/org/apache/nifi/components/DescribedValue.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */
package org.apache.nifi.components;

/**
 * Describes a component property value with display name and description.
 */
public interface DescribedValue {

    /**
     * @return the property value as a string
     */
    String getValue();

    /**
     * @return the property display name as a string
     */
    String getDisplayName();

    /**
     * @return the property description as a string
     */
    String getDescription();

    DescribedValue NULL = new DescribedValue() {
        @Override
        public String getValue() {
            return null;
        }

        @Override
        public String getDisplayName() {
            return "NULL";
        }

        @Override
        public String getDescription() {
            return "A null value";
        }
    };
}