com.ibm.util.merge.directive.Require.java Source code

Introduction

Here is the source code for com.ibm.util.merge.directive.Require.java

Source

/*
 * Copyright 2015, 2015 IBM
 * 
 * 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.ibm.util.merge.directive;

import com.ibm.util.merge.MergeContext;
import com.ibm.util.merge.MergeException;
import com.ibm.util.merge.template.Template;

import java.util.ArrayList;
import java.util.Arrays;

import org.apache.commons.lang3.StringUtils;

/**
 * A validation directive 
 * Allows a template to specify a set of replace values that must be on the 
 * replace stack. Supports more meaningful error messages on merge failures.
 * 
 * DEFERRED IMPLEMENTATION
 *
 * @author  Mike Storey
 */
public class Require extends AbstractDirective {
    private ArrayList<String> tags = new ArrayList<>();

    /**
     * Simple Constructor
     */
    public Require() {
        super();
        this.setDescription("Require Tags");
        setType(Directives.TYPE_REQUIRE);
        setProvider(null);
    }

    public Require asNew() {
        Require to = new Require();
        to.copyFieldsFrom(this);
        to.setTags(this.getTags());
        return to;
    }

    /**
     * Check to see if the tags are in the replace stack, throw an exception if not found
     * @see AbstractDirective#executeDirective(MergeContext)
     * @param tf
     * @param rtc
     */
    @Override
    public void executeDirective(MergeContext rtc) throws MergeException {
        for (String tag : tags) {
            if (!getTemplate().hasReplaceValue(Template.wrap(tag))) {
                throw new MergeException(this, null, "Required Tag Not Found in " + getTemplate().getFullName(),
                        this.getTags());
            }
        }
    }

    public String getTags() {
        return StringUtils.join(tags, ",");
    }

    public void setTags(String tags) {
        this.tags = new ArrayList<>(Arrays.asList(tags.split(",")));
    }

    public String getD1() {
        return this.getTags();
    }

    public void setD1(String value) {
        this.setTags(value);
    }

    public String getD2() {
        return "";
    }

    public void setD2(String value) {
        return;
    }

    public String getD3() {
        return "";
    }

    public void setD3(String value) {
        return;
    }

    public String getD4() {
        return "";
    }

    public void setD4(String value) {
        return;
    }

}