com.speedment.runtime.compute.expression.JoiningExpression Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of tool-deploy Show documentation

A Speedment bundle that shades all dependencies into one jar. This is useful when deploying an application on a server.

The newest version!

/*
 *
 * Copyright (c) 2006-2019, Speedment, Inc. All Rights Reserved.
 *
 * 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.
 */
package com.speedment.runtime.compute.expression;

import com.speedment.runtime.compute.ToString;

import java.util.List;

/**
 * A special type of {@link ToString} expression that joins several strings
 * together using optionally a separator, a prefix and a suffix.
 *
 * @param   the input entity type
 *
 * @author Emil Forslund
 * @since  3.1.0
 */
public interface JoiningExpression extends ToString {

    /**
     * Returns an unmodifiable list of the expressions that are joined together
     * in this expression. Whenever an entity is passed to this expression, the
     * result will be the result of passing the same entity to all these
     * expressions and joining them together with an optional {@link #prefix()},
     * {@link #separator()} and {@link #suffix()}.
     *
     * @return  unmodifiable list of expressions that make up this expression
     */
    List> expressions();

    /**
     * Returns the prefix to put in front of the result of this expression. If
     * no prefix is used, then this method will return an empty string.
     *
     * @return  the prefix
     */
    CharSequence prefix();

    /**
     * Returns the suffix to put at the end of the result of this expression. If
     * no suffix is used, then this method will return an empty string.
     *
     * @return  the suffix
     */
    CharSequence suffix();

    /**
     * Returns the separator that will be placed in-between the results of all
     * the {@link #expressions()} to separate them. If no separator is used,
     * then this method will return an empty string.
     *
     * @return  the separator
     */
    CharSequence separator();

}