qpid/java/broker-plugins/experimental/info/src/main/java/org/apache/qpid/info/Info.java

/*
 *
 * 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.
 *
 */

/**
 *
 * @author sorin
 *
 *  Info object
 */

package org.apache.qpid.info;

import org.apache.qpid.info.util.XMLWriter;

import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Properties;

/**
 * The Info class encapsulates all the information we are collecting
 * and it is able to render it in different data representations
 */
public class Info<T extends Map<String, ?>>
{
    private T _info;

    /**
     * Constructor.
     *
     * @param info instantiates the object with a Map<String,?>
     */
    public Info(T info)
    {
        _info = info;
    }

    @Override
    public String toString()
    {
        String result = "";
        for (Iterator<String> it = _info.keySet().iterator(); it.hasNext();)
        {
            String str = it.next();
            result += str + "=" + _info.get(str).toString() + "\n";
        }
        return result;
    }

    /**
     * Renders Info map to a property object
     *
     * @return A Properties object representing the Info map
     */
    public Properties toProps()
    {
        Properties props = new Properties();
        if (null == _info)
        {
            return null;
        }
        for (Iterator<String> it = _info.keySet().iterator(); it.hasNext();)
        {
            String key = it.next();
            props.put(key, _info.get(key));
        }
        return props;
    }

    /**
     * Renders Info map to a StringBuffer
     *
     * @return A StringBuffer object representing the Info map
     */
    public StringBuffer toStringBuffer()
    {
        StringBuffer sb = new StringBuffer();
        for (Iterator<String> it = _info.keySet().iterator(); it.hasNext();)
        {
            String str = it.next();
            sb.append(str + "=" + _info.get(str).toString() + "\n");
        }
        return sb;
    }

    /**
     * Renders Info map to a StringBuffer containing an XML string
     *
     * @return A StringBuffer object containing an XML representation of the Info map
     */
    public StringBuffer toXML()
    {
        XMLWriter xw = new XMLWriter(new StringBuffer());
        xw.writeXMLHeader();
        Map<String, String> attr = new HashMap<String, String>();
        xw.writeOpenTag("qpidinfo", attr);
        String key;
        for (Iterator<String> it = _info.keySet().iterator(); it.hasNext();)
        {
            attr.clear();
            key = it.next();
            xw.writeTag(key, attr, _info.get(key).toString());
        }
        xw.writeCloseTag("qpidinfo");
        return xw.getXML();
    }

    /**
     * Renders Info map to a HashMap
     *
     * @return A HashMap object representing the Info map
     */
    public HashMap<String, String> toMap()
    {
        String key;
        HashMap<String, String> infoMap = new HashMap<String, String>();
        for (Iterator<String> it = _info.keySet().iterator(); it.hasNext();)
        {
            key = it.next();
            infoMap.put(key, _info.get(key).toString());
        }
        return infoMap;
    }

}