Java Properties to String propertiesToString(Properties props, String comment)

Description

Converts properties to string representation

License

Apache License

Parameter

Parameter	Description
props	a parameter
comment	optional comment (can be null)

Return

String (standard key=value format)

Declaration

public static String propertiesToString(Properties props, String comment) 

Method Source Code

//package com.java2s;
/**//  w  w  w. j  a v a 2 s  .co  m
 * 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.
 */

import java.io.IOException;
import java.io.StringWriter;

import java.util.Properties;

public class Main {
    /**
     * Converts properties to string representation
     * @param props
     * @param comment optional comment (can be null)
     * @return String (standard key=value format)
     */
    public static String propertiesToString(Properties props, String comment) {
        StringWriter writer = new StringWriter();
        try {
            props.store(writer, comment);
        } catch (IOException e) {
            // never happens for StringWriter
        }
        return writer.toString();
    }
}

Related

1. propertiesToString(final Properties properties)
2. propertiesToString(Properties p)
3. propertiesToString(Properties properties)
4. propertiesToString(Properties properties)
5. propertiesToString(Properties props)