BatchContextApi.java

/**
 * Copyright 2011-2017 Asakusa Framework Team.
 *
 * 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.asakusafw.runtime.core.api;

/**
 * The Batch Context API.
 * @since 0.9.0
 */
public interface BatchContextApi {

    /**
     * Returns a value of the context variable (which includes batch arguments).
     * @param name the target variable name
     * @return the value of the target variable, or {@code null} if it is not defined in this context
     * @throws IllegalArgumentException if the parameter is {@code null}
     */
    String get(String name);
}