org.jasypt.encryption.pbe.config.SimpleStringPBEConfig Maven / Gradle / Ivy

/*
 * =============================================================================
 * 
 *   Copyright (c) 2007-2010, The JASYPT team (http://www.jasypt.org)
 * 
 *   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 org.jasypt.encryption.pbe.config;

import org.jasypt.commons.CommonUtils;


/**
 * 
 * Bean implementation for {@link StringPBEConfig}. This class allows 
 * the values for the configuration parameters to be set
 * via "standard" setX methods.
 * 
 * 
 * For any of the configuration parameters, if its setX
 * method is not called, a null value will be returned by the
 * corresponding getX method. 
 * 
 * 
 * @since 1.3
 * 
 * @author Daniel Fernández
 * 
 */
public class SimpleStringPBEConfig
        extends SimplePBEConfig
        implements StringPBEConfig {
    
    private String stringOutputType = null;


    /**
     * 
     * Creates a new SimpleStringPBEConfig instance.
     * 
     */
    public SimpleStringPBEConfig() {
        super();
    }

    
    /**
     * 
     * Sets the the form in which String output
     * will be encoded. Available encoding types are:
     * 
     * 
     *   base64 (default)
     *   hexadecimal
     * 
     * 
     * If not set, null will be returned.
     * 
     * 
     * Determines the result of: {@link #getStringOutputType()}
     * 
     * 
     * @param stringOutputType the string output type.
     */
    public void setStringOutputType(final String stringOutputType) {
        this.stringOutputType = 
            CommonUtils.
                getStandardStringOutputType(stringOutputType);
    }

    
    public String getStringOutputType() {
        return this.stringOutputType;
    }

    
}