/*
 * Copyright (c) 2008-2009, Motorola, Inc.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * - Neither the name of the Motorola, Inc. nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

package javax.obex;

/**
 * Represents an Application Parameter header for OBEX as defined by the IrDA specification.
 */
public final class ApplicationParameter {

    private byte[] mArray;

    private int mLength;

    private int mMaxLength = 1000;

    /**
     * Possible values for the tag field in the Application Parameter header.
     */
    public static class TRIPLET_TAGID {
        public static final byte ORDER_TAGID = 0x01;

        public static final byte SEARCH_VALUE_TAGID = 0x02;

        public static final byte SEARCH_ATTRIBUTE_TAGID = 0x03;

        // if equals to "0", PSE only reply number of contacts
        public static final byte MAXLISTCOUNT_TAGID = 0x04;

        public static final byte LISTSTARTOFFSET_TAGID = 0x05;

        public static final byte PROPERTY_SELECTOR_TAGID = 0x06;

        public static final byte FORMAT_TAGID = 0x07;

        // only used if max list count = 0
        public static final byte PHONEBOOKSIZE_TAGID = 0x08;

        // only used in "mch" in response
        public static final byte NEWMISSEDCALLS_TAGID = 0x09;

        public static final byte SUPPORTEDFEATURE_TAGID = 0x10;

        public static final byte PRIMARYVERSIONCOUNTER_TAGID = 0x0A;

        public static final byte SECONDARYVERSIONCOUNTER_TAGID = 0x0B;

        public static final byte VCARDSELECTOR_TAGID = 0x0C;

        public static final byte DATABASEIDENTIFIER_TAGID = 0x0D;

        public static final byte VCARDSELECTOROPERATOR_TAGID = 0x0E;

        public static final byte RESET_NEW_MISSED_CALLS_TAGID = 0x0F;
    }

    /**
     * Possible values for the value field in the Application Parameter header.
     */
    public static class TRIPLET_VALUE {
        public static class ORDER {
            public static final byte ORDER_BY_INDEX = 0x00;

            public static final byte ORDER_BY_ALPHANUMERIC = 0x01;

            public static final byte ORDER_BY_PHONETIC = 0x02;
        }

        public static class SEARCHATTRIBUTE {
            public static final byte SEARCH_BY_NAME = 0x00;

            public static final byte SEARCH_BY_NUMBER = 0x01;

            public static final byte SEARCH_BY_SOUND = 0x02;
        }

        public static class FORMAT {
            public static final byte VCARD_VERSION_21 = 0x00;

            public static final byte VCARD_VERSION_30 = 0x01;
        }
    }

    /**
     * Possible values for the length field in the Application Parameter header.
     */
    public static class TRIPLET_LENGTH {
        public static final byte ORDER_LENGTH = 1;

        public static final byte SEARCH_ATTRIBUTE_LENGTH = 1;

        public static final byte MAXLISTCOUNT_LENGTH = 2;

        public static final byte LISTSTARTOFFSET_LENGTH = 2;

        public static final byte PROPERTY_SELECTOR_LENGTH = 8;

        public static final byte FORMAT_LENGTH = 1;

        public static final byte PHONEBOOKSIZE_LENGTH = 2;

        public static final byte NEWMISSEDCALLS_LENGTH = 1;

        public static final byte SUPPORTEDFEATURE_LENGTH = 4;

        public static final byte PRIMARYVERSIONCOUNTER_LENGTH = 16;

        public static final byte SECONDARYVERSIONCOUNTER_LENGTH = 16;

        public static final byte VCARDSELECTOR_LENGTH = 8;

        public static final byte DATABASEIDENTIFIER_LENGTH = 16;

        public static final byte VCARDSELECTOROPERATOR_LENGTH = 1;

        public static final byte RESETNEWMISSEDCALLS_LENGTH = 1;
    }

    /**
     * Constructs an ApplicationParameter header
     */
    public ApplicationParameter() {
        mArray = new byte[mMaxLength];
        mLength = 0;
    }

    /**
     * Adds a triplet of tag, length, and value to this application parameter header as per the
     * IrDA specifications.
     *
     * @param tag one of {@link TRIPLET_TAGID}
     * @param len one of {@link TRIPLET_LENGTH}
     * @param value is the value required for the supplied tag
     */
    public void addTriplet(byte tag, byte len, byte[] value) {
        if ((mLength + len + 2) > mMaxLength) {
            byte[] array_tmp = new byte[mLength + 4 * len];
            System.arraycopy(mArray, 0, array_tmp, 0, mLength);
            mArray = array_tmp;
            mMaxLength = mLength + 4 * len;
        }
        mArray[mLength++] = tag;
        mArray[mLength++] = len;
        System.arraycopy(value, 0, mArray, mLength, len);
        mLength += len;
    }

    /**
     * Gets the application parameter header as a byte array.
     *
     * @return a byte array representing the application parameter header
     */
    public byte[] getHeader() {
        byte[] para = new byte[mLength];
        System.arraycopy(mArray, 0, para, 0, mLength);
        return para;
    }
}