org.springframework.batch.item.util.ExecutionContextUserSupport.java Source code

Introduction

Here is the source code for org.springframework.batch.item.util.ExecutionContextUserSupport.java

Source

/*
 * Copyright 2006-2007 the original author or authors.
 *
 * 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
 *
 *      https://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.springframework.batch.item.util;

import org.springframework.batch.item.ExecutionContext;
import org.springframework.util.Assert;

/**
 * Facilitates assigning names to objects persisting data in {@link ExecutionContext} and generating keys for
 * {@link ExecutionContext} based on the name.
 * 
 * @author Robert Kasanicky
 */
public class ExecutionContextUserSupport {

    private String name;

    public ExecutionContextUserSupport() {
        super();
    }

    public ExecutionContextUserSupport(String name) {
        super();
        this.name = name;
    }

    /**
     * @return name used to uniquely identify this instance's entries in shared context.
     */
    protected String getName() {
        return this.name;
    }

    /**
     * @param name unique name used to create execution context keys.
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * Prefix the argument with {@link #getName()} to create a unique key that can be safely used to identify data
     * stored in {@link ExecutionContext}.
     *
     * @param suffix {@link String} to be used to generate the key.
     * @return the key that was generated based on the name and the suffix.
     */
    public String getKey(String suffix) {
        Assert.hasText(name, "Name must be assigned for the sake of defining the execution context keys prefix.");
        return name + "." + suffix;
    }

}