DescriptionStringBuilder.java

/**
 * Licensed to the Austrian Association for Software Tool Integration (AASTI)
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. The AASTI 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.openengsb.core.ekb.transformation.wonderland.internal.operation;

/**
 * The description string builder is a helper class built with the builder pattern. It helps to create the string for
 * the transformation operation description.
 */
public class DescriptionStringBuilder {
    private String operationName;
    private StringBuilder builder;

    public DescriptionStringBuilder(String operationName) {
        this.operationName = operationName;
        builder = new StringBuilder();
    }

    /**
     * Starts to create a new description, everything that has been added so far will be deleted.
     */
    public DescriptionStringBuilder does(String description) {
        builder = new StringBuilder(description);
        return this;
    }

    /**
     * Continues the description of the operation.
     */
    public DescriptionStringBuilder cnt(String description) {
        builder.append(description);
        return this;
    }

    @Override
    public String toString() {
        return String.format("The '%s' operation %s", operationName, builder.toString());
    }
}