MetInf.java

/*
 * Funambol is a mobile platform developed by Funambol, Inc.
 * Copyright (C) 2003 - 2007 Funambol, Inc.
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by
 * the Free Software Foundation with the addition of the following permission
 * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
 * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE
 * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program; if not, see http://www.gnu.org/licenses or write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301 USA.
 *
 * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite
 * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com.
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License version 3.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License
 * version 3, these Appropriate Legal Notices must retain the display of the
 * "Powered by Funambol" logo. If the display of the logo is not reasonably
 * feasible for technical reasons, the Appropriate Legal Notices must display
 * the words "Powered by Funambol".
 */
package com.funambol.syncml.protocol;

import java.util.*;

/**
 * This class represents the <MetInf> tag as defined by the SyncML
 * representation specifications.
 */
public class MetInf implements ReusableObject {

    // ------------------------------------------------------------ Private data
    private Boolean   fieldLevel;
    private String    format    ;
    private String    type      ;
    private String    mark      ;
    private Anchor    anchor    ;
    private String    version   ;
    private NextNonce nextNonce ;
    private Long      maxMsgSize;
    private Long      maxObjSize;
    private Long      size      ;
    private Vector    emi = new Vector();
    private Mem       mem       ;
    // ------------------------------------------------------------ Constructors

    /**
     * For serialization purposes
     */
    MetInf() {
        set(null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null
        );
    }

    // ---------------------------------------------------------- Public methods
    public static MetInf newInstance() {
        return ObjectsPool.createMetInf();
    }

    /**
     * Returns the fieldLevel value
     *
     * @return <i>true</i> if the content information replaces only part of
     *         an Item, <i>false</i> otherwise
     */
    public boolean isFieldLevel() {
        return (fieldLevel != null);
    }

    /**
     * Sets the fieldLevel property
     *
     * @param fieldLevel the field level property
     */
    public void setFieldLevel(Boolean fieldLevel) {
        if (fieldLevel != null && fieldLevel.booleanValue()) {
            this.fieldLevel = fieldLevel;
        } else {
            this.fieldLevel = null;
        }
    }

    /**
     * Gets the Boolean field level property
     *
     * @return FieldLevel the Boolean field level property
     */
    public Boolean getFieldLevel() {
        if (fieldLevel == null || !fieldLevel.booleanValue()) {
            return null;
        }
        return fieldLevel;
    }

    /**
     * Returns dateSize (in bytes)
     *
     * @return size
     */
    public Long getSize() {
        return size;
    }

    /**
     * Sets size
     *
     * @param size the new size value
     */
    public void setSize(Long size) {
        this.size = size;
    }

    /**
     * Returns format
     *
     * @return format
     */
    public String getFormat() {
        return format;
    }

    /**
     * Sets format
     *
     * @param format the new format value
     */
    public void setFormat(String format) {
        this.format = format;
    }

    /**
     * Returns type
     *
     * @return type
     */
    public String getType() {
        return type;
    }

    /**
     * Sets type
     *
     * @param type the new type value
     */
    public void setType(String type) {
        this.type = type;
    }

    /**
     * Returns mark
     *
     * @return mark
     */
    public String getMark() {
        return mark;
    }

    /**
     * Sets mark
     *
     * @param mark the new mark value
     */
    public void setMark(String mark) {
        this.mark = mark;
    }

    /**
     * Returns anchor
     *
     * @return anchor
     */
    public Anchor getAnchor() {
        return anchor;
    }

    /**
     * Sets anchor
     *
     * @param anchor the new anchor value
     */
    public void setAnchor(Anchor anchor) {
        this.anchor = anchor;
    }

    /**
     * Returns version
     *
     * @return version
     */
    public String getVersion() {
        return version;
    }

    /**
     * Sets version
     *
     * @param version the new version value
     */
    public void setVersion(String version) {
        this.version = version;
    }

    /**
     * Returns nextNonce
     *
     * @return nextNonce
     */
    public NextNonce getNextNonce() {
        return nextNonce;
    }

    /**
     * Sets nextNonce
     *
     * @param nextNonce the new nextNonce value
     */
    public void setNextNonce(NextNonce nextNonce) {
        this.nextNonce = nextNonce;
    }

    /**
     * Returns maxMsgSize
     *
     * @return maxMsgSize
     */
    public Long getMaxMsgSize() {
        return maxMsgSize;
    }

    /**
     * Sets maxMsgSize
     *
     * @param maxMsgSize the new maxMsgSize value
     */
    public void setMaxMsgSize(Long maxMsgSize) {
        this.maxMsgSize = maxMsgSize;
    }

    /**
     * Returns maxObjSize
     *
     * @return maxObjSize
     */
    public Long getMaxObjSize() {
        return maxObjSize;
    }

    /**
     * Sets maObjSize
     *
     * @param maxObjSize the new maxObjSize value
     */
    public void setMaxObjSize(Long maxObjSize) {
        this.maxObjSize = maxObjSize;
    }

    /**
     * Returns emi
     *
     * @return emi
     */
    public Vector getEMI() {
        return emi;
    }

    /**
     * Sets emi from an Vector
     *
     * @param emi the new emi value
     */
    public void setEMI(Vector emi) {
        this.emi = emi;
    }

    /**
     * Returns mem
     *
     * @return mem
     */
    public Mem getMem() {
        return mem;
    }

    /**
     * Sets mem
     *
     * @param mem the new mem value
     */
    public void setMem(Mem mem) {
        this.mem = mem;
    }

    // --------------------------------------------------------- Private methods

    /**
     * Sets all properties in once.
     *
     * @param format the encoding format
     * @param type usually a MIME type
     * @param mark the mark element
     * @param sizeInBytes the data size in bytes
     * @param anchor the Anchor
     * @param version the data version
     * @param nonce the next nonce value
     * @param maxMsgSize the maximum message size in bytes
     * @param emi experimental meta info
     * @param memoryInfo memory information
     *
     */
    private void set(final Boolean   fieldLevel,
                     final String    format    ,
                     final String    type      ,
                     final String    mark      ,
                     final Long      size      ,
                     final Anchor    anchor    ,
                     final String    version   ,
                     final NextNonce nonce     ,
                     final Long      maxMsgSize,
                     final Long      maxObjSize,
                     final Vector    emi       ,
                     final Mem       mem       ) {
        setFieldLevel(fieldLevel);
        this.format     = format;
        this.type       = type;
        this.mark       = mark;
        this.anchor     = anchor;
        this.size       = size;
        this.version    = version;
        this.nextNonce  = nonce;
        this.maxMsgSize = maxMsgSize;
        this.maxObjSize = maxObjSize;
        this.mem        = mem;
        setEMI(emi);
    }

    public void init() {
        fieldLevel = null;
        format     = null;
        type       = null;
        mark       = null;
        anchor     = null;
        version    = null;
        nextNonce  = null;
        maxMsgSize = null;
        maxObjSize = null;
        size       = null;
        mem        = null;
        if (emi != null) {
            emi.removeAllElements();
        }
    }
}