PluginPropertyFactory.java

/*! ******************************************************************************
 *
 * Pentaho Data Integration
 *
 * Copyright (C) 2002-2013 by Pentaho : http://www.pentaho.com
 *
 *******************************************************************************
 *
 * 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.pentaho.di.core.util;

/**
 * @author <a href="mailto:thomas.hoedl@aschauer-edv.at">Thomas Hoedl(asc042)</a>
 *
 */
public class PluginPropertyFactory {

  private final KeyValueSet properties;

  /**
   * Constructor.
   *
   * @param properties
   *          properties to set.
   * @throws IllegalArgumentException
   *           if properties is null.
   */
  public PluginPropertyFactory( final KeyValueSet properties ) throws IllegalArgumentException {
    Assert.assertNotNull( properties, "Properties cannot be null" );
    this.properties = properties;
  }

  /**
   * @return the properties
   */
  public KeyValueSet getProperties() {
    return this.properties;
  }

  /**
   * @param key
   *          key to set.
   * @return new string property.
   * @throws IllegalArgumentException
   *           if key is invalid.
   */
  public StringPluginProperty createString( final String key ) throws IllegalArgumentException {
    final StringPluginProperty property = new StringPluginProperty( key );
    this.properties.add( property );
    return property;
  }

  /**
   * @param key
   *          key to set.
   * @return new integer property.
   * @throws IllegalArgumentException
   *           if key is invalid.
   */
  public IntegerPluginProperty createInteger( final String key ) throws IllegalArgumentException {
    final IntegerPluginProperty property = new IntegerPluginProperty( key );
    this.properties.add( property );
    return property;
  }

  /**
   * @param key
   *          key to set.
   * @return new boolean property.
   * @throws IllegalArgumentException
   *           if key is invalid.
   */
  public BooleanPluginProperty createBoolean( final String key ) throws IllegalArgumentException {
    final BooleanPluginProperty property = new BooleanPluginProperty( key );
    this.properties.add( property );
    return property;
  }

  /**
   * @param key
   *          key.
   * @return new string list.
   * @throws IllegalArgumentException
   *           if key is invalid.
   */
  public StringListPluginProperty createStringList( final String key ) throws IllegalArgumentException {
    final StringListPluginProperty property = new StringListPluginProperty( key );
    this.properties.add( property );
    return property;
  }
}