/**
 * Copyright 2005-2013 Restlet S.A.S.
 * 
 * The contents of this file are subject to the terms of one of the following
 * open source licenses: Apache 2.0 or LGPL 3.0 or LGPL 2.1 or CDDL 1.0 or EPL
 * 1.0 (the "Licenses"). You can select the license that you prefer but you may
 * not use this file except in compliance with one of these Licenses.
 * 
 * You can obtain a copy of the Apache 2.0 license at
 * http://www.opensource.org/licenses/apache-2.0
 * 
 * You can obtain a copy of the LGPL 3.0 license at
 * http://www.opensource.org/licenses/lgpl-3.0
 * 
 * You can obtain a copy of the LGPL 2.1 license at
 * http://www.opensource.org/licenses/lgpl-2.1
 * 
 * You can obtain a copy of the CDDL 1.0 license at
 * http://www.opensource.org/licenses/cddl1
 * 
 * You can obtain a copy of the EPL 1.0 license at
 * http://www.opensource.org/licenses/eclipse-1.0
 * 
 * See the Licenses for the specific language governing permissions and
 * limitations under the Licenses.
 * 
 * Alternatively, you can obtain a royalty free commercial license with less
 * limitations, transferable or non-transferable, directly at
 * http://www.restlet.com/products/restlet-framework
 * 
 * Restlet is a registered trademark of Restlet S.A.S.
 */

package org.restlet.ext.sip.internal;

import java.util.List;

import org.restlet.data.Parameter;
import org.restlet.engine.header.HeaderWriter;
import org.restlet.ext.sip.Address;

/**
 * Address like header writer.
 * 
 * @author Thierry Boileau
 */
public class AddressWriter extends HeaderWriter<Address> {

    /** Indicates if the tag parameter should be included. */
    private final boolean includingTag;

    /**
     * Default constructor.
     */
    public AddressWriter() {
        this(true);
    }

    /**
     * Constructor.
     * 
     * @param includingTag
     *            Indicates if the tag parameter should be included.
     */
    public AddressWriter(boolean includingTag) {
        this.includingTag = includingTag;
    }

    /**
     * Writes an address.
     * 
     * @param address
     *            The address.
     * @return The formatted address.
     */
    public static String write(Address address) {
        return write(address, true);
    }

    /**
     * Writes an address.
     * 
     * @param address
     *            The address.
     * @return The formatted address.
     */
    public static String write(Address address, boolean includeTag) {
        return new AddressWriter(includeTag).append(address).toString();
    }

    /**
     * Writes a list of addresses with a comma separator.
     * 
     * @param addresses
     *            The list of addresses.
     * @return The formatted list of addresses.
     */
    public static String write(List<Address> addresses) {
        return new AddressWriter(true).append(addresses).toString();
    }

    @Override
    public HeaderWriter<Address> append(Address address) {
        if (address != null) {
            if (address.getDisplayName() != null) {
                appendQuotedString(address.getDisplayName());
                append(" ");
            }

            append("<");
            append(address.getReference().toString());
            append("> ");

            if (!address.getParameters().isEmpty()) {
                for (Parameter param : address.getParameters()) {
                    if (includingTag || !"tag".equals(param.getName())) {
                        appendParameterSeparator();
                        appendExtension(param);
                    }
                }
            }
        }

        return this;
    }

}