/*
    * Copyright 2008 The Kuali Foundation
    *
    * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
    *
   * 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.kuali.rice.core.util;
  
  import org.apache.commons.lang.StringUtils;
  
  import java.util.HashMap;
  import java.util.Map;
  
  /**
   * Specialization of HashMap to facilitate web services and simplify API definitions.
   * 
   * @author Kuali Rice Team (rice.collab@kuali.org)
   *
   */
  public class AttributeSet extends HashMap<String,String> {
  
  	private static final long serialVersionUID = -5960854367616060667L;
  
  	public AttributeSet() {
  		super();
  	}
  	
  	/**
  	 * Create an AttributeSet with a single key/value pair.
  	 */
  	public AttributeSet( String key, String value ) {
  		this();
  		put( key, value );
  	}
  	
  	/**
  	 * @see HashMap#HashMap(int)
  	 * 
  	 * @param initialSize
  	 */
  	public AttributeSet( int initialSize ) {
  		super( initialSize );
  	}
  	
  	public AttributeSet( Map<String,String> map ) {
  		super();
  		if ( map != null ) {
  			putAll( map );
  		}
  	}
  	
  	public String formattedDump( int indent ) {
  		int maxKeyLen = 1;
  		for ( String key : this.keySet() ) {
  			if ( key.length() > maxKeyLen ) {
  				maxKeyLen = key.length();
  			}
  		}
  		StringBuffer sb = new StringBuffer();
  		String indentStr = StringUtils.repeat( " ", indent );
  		for ( String key : this.keySet() ) {
  			sb.append( indentStr );
  			sb.append( StringUtils.rightPad( key, maxKeyLen, ' ' ));
  			sb.append( " --> " );
  			sb.append( get( key ) );
  			sb.append( '\n' );
  		}
  		return sb.toString();
  	}
  }