Sorts a property list and turns the sorted list into a string. : Properties « Development Class « Java






Sorts a property list and turns the sorted list into a string.

       
import java.io.IOException;
import java.io.InputStream;
import java.util.Enumeration;
import java.util.Properties;

/*

   Derby - Class org.apache.derby.iapi.util.PropertyUtil

   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to you 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.

 */



public class Main {

  /**
   * Sorts a property list and turns the sorted list into a string.
   *
   * @param  list  property list to sort
   *
   * @return a string version of the sorted list
   */
 public  static  String  sortProperties( Properties list )
 {
   // stringify them with no indentation
   return sortProperties(list, null);
 }
  /**
   * Sorts property list and print out each key=value pair prepended with 
   * specific indentation.  If indent is null, do not prepend with
   * indentation. 
   *
   * The output string shows up in two styles, style 1 looks like
   * { key1=value1, key2=value2, key3=value3 }
   *
   * style 2 looks like
   *    key1=value1
   *    key2=value2
   *    key3=value3
   * where indent goes between the new line and the keys
   *
   * To get style 1, pass in a null indent
   * To get sytle 2, pass in non-null indent (whatever you want to go before
   * the key value)
   */
  public  static  String  sortProperties( Properties list, String indent )
  {
    int       size = list == null ? 0 : list.size();
    int       count = 0;
    String[]    array = new String[size];
    String      key;
    String      value;
    StringBuffer  buffer;

    // Calculate the number of properties in the property list and
    // build an array of all the property names.
    // We need to go thru the enumeration because Properties has a
    // recursive list of defaults.
    if (list != null)
    {
      for (Enumeration propertyNames = list.propertyNames();
         propertyNames.hasMoreElements(); )
      {
        if (count == size)
        {
          // need to expand the array
          size = size*2;
          String[] expandedArray = new String[size];
          System.arraycopy(array, 0, expandedArray, 0, count);
          array = expandedArray;
        }
        key = (String) propertyNames.nextElement();
        array[ count++ ] = key;
      }

      // now sort the array
      java.util.Arrays.sort(array, 0, count);
    }

    // now stringify the array
    buffer = new StringBuffer();
    if (indent == null)
      buffer.append( "{ " );

    for ( int ictr = 0; ictr < count; ictr++ )
    {
      if ( ictr > 0 && indent == null)
        buffer.append( ", " );

      key = array[ ictr ];

      if (indent != null)
        buffer.append( indent );

      buffer.append( key ); buffer.append( "=" );

      value = list.getProperty( key, "MISSING_VALUE" );
      buffer.append( value );

      if (indent != null)
        buffer.append( "\n" );

    }
    if (indent == null)
      buffer.append( " }" );

    return  buffer.toString();
  }

}

   
    
    
    
    
    
    
  








Related examples in the same category

1.Read a set of properties from the received input stream, strip off any excess white space that exists in those property values,
2.Copy a set of properties from one Property to another.
3.Sorts property list and print out each key=value pair prepended with specific indentation.
4.A utility class for replacing properties in strings.
5.Property Loader
6.Property access utility methods
7.Represents a persistent set of properties
8.Converts specified map to java.util.Properties
9.A java.util.Properties class that will check a file or URL for changes periodically
10.Encapsulates java.util.Properties to add java primitives and some other java classes
11.Load and save properties to files.
12.Adds new properties to an existing set of properties
13.Extracts a specific property key subset from the known properties
14.Observable Properties
15.Merge Properties Into Map
16.XML configuration management
17.JDOM based XML properties
18.XML Properties
19.Converts Unicode into something that can be embedded in a java properties file
20.Create Properties from String array
21.Task to overwrite Properties
22.Gets strong-type-value property from a standard Properties
23.The properties iterator iterates over a set of enumerated properties.
24.An utility class to ease up using property-file resource bundles.
25.Sorted Properties
26.A subclass of the java.util.Properties class that must be initialized from a file on disk
27.This class contains a collection of static utility methods for creating, retrieving, saving and loading properties.
28.Simplify routine job with properties
29.Property Manager