PropertiesFunction.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 io.fabric8.karaf.core.properties.function;

/**
 * A function that is applied instead of looking up a property placeholder.
 */
public interface PropertiesFunction {

    /**
     * Name of the function which is used as <tt>name:</tt> to let the properties component know its a function.
     */
    String getName();

    /**
     * Applies the function
     *
     * @param remainder    the remainder value
     * @return a value as the result of the function
     */
    String apply(String remainder);

}