atom.content.pm.AbstractInfo Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2014 Geeoz, and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Research Projects is dual-licensed under the GNU General Public
 * License, version 2.0 (GPLv2) and the Geeoz Commercial License.
 *
 * Solely for non-commercial purposes. A purpose is non-commercial only if
 * it is in no manner primarily intended for or directed toward commercial
 * advantage or private monetary compensation.
 *
 * This Geeoz Software is supplied to you by Geeoz in consideration of your
 * agreement to the following terms, and your use, installation, modification
 * or redistribution of this Geeoz Software constitutes acceptance of these
 * terms. If you do not agree with these terms, please do not use, install,
 * modify or redistribute this Geeoz Software.
 *
 * Neither the name, trademarks, service marks or logos of Geeoz may be used
 * to endorse or promote products derived from the Geeoz Software without
 * specific prior written permission from Geeoz.
 *
 * The Geeoz Software is provided by Geeoz on an "AS IS" basis. GEEOZ MAKES NO
 * WARRANTIES, EXPRESS  OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
 * WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE, REGARDING THE GEEOZ SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
 * COMBINATION WITH YOUR PRODUCTS.
 *
 * IN NO EVENT SHALL GEEOZ BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
 * AND/OR DISTRIBUTION OF THE GEEOZ SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER
 * THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR
 * OTHERWISE, EVEN IF GEEOZ HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * A copy of the GNU General Public License is included in the distribution in
 * the file LICENSE and at
 *
 *     http://www.gnu.org/licenses/gpl-2.0.html
 *
 * If you are using the Research Projects for commercial purposes, we
 * encourage you to visit
 *
 *     http://products.geeoz.com/license
 *
 * for more details.
 *
 * This software or hardware and documentation may provide access to
 * or information on content, products, and services from third parties.
 * Geeoz and its affiliates are not responsible for and expressly disclaim
 * all warranties of any kind with respect to third-party content, products,
 * and services. Geeoz and its affiliates will not be responsible for any loss,
 * costs, or damages incurred due to your access to or use of third-party
 * content, products, or services. If a third-party content exists, the
 * additional copyright notices and license terms applicable to portions of the
 * software are set forth in the THIRD_PARTY_LICENSE_README file.
 *
 * Please contact Geeoz or visit www.geeoz.com if you need additional
 * information or have any questions.
 */

package atom.content.pm;

import javax.xml.bind.Unmarshaller;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlTransient;
import javax.xml.bind.annotation.XmlType;
import java.util.HashSet;
import java.util.Objects;
import java.util.Set;

/**
 * Information you can retrieve about a particular application entry. This
 * corresponds to information collected from the manifest.atom.xml.
 *
 * @param  information type
 * @author Alex Voloshyn
 * @version 1.1 4/20/14
 */
@XmlType(namespace = AbstractInfo.MANIFEST_NAMESPACE)
public abstract class AbstractInfo {
    /**
     * JAXB manifest namespace.
     */
    public static final String MANIFEST_NAMESPACE =
            "http://atom.geeoz.com/manifest/1.0";
    /**
     * An activity alias, this is the real activity class to run for it.
     */
    private Class className;
    /**
     * Set of the intent filter that corresponding for this activity.
     */
    private final Set filters = new HashSet<>();
    /**
     * An activity package information.
     */
    private PackageInfo packageInfo;

    /**
     * Retrieve the real activity class.
     *
     * @return the real activity class
     */
    @XmlAttribute(name = "name", required = true)
    public final Class getClassName() {
        return className;
    }

    /**
     * Set the real activity class.
     *
     * @param cls the real activity class
     */
    public final void setClassName(final Class cls) {
        className = cls;
    }

    /**
     * Add a new IntentFilter to existing filter list.
     *
     * @param filter intent filter to add
     */
    public final void addIntentFilter(final IntentFilter filter) {
        if (!filters.contains(filter)) {
            filters.add(filter);
        }
    }

    /**
     * Retrieve set of the intent filter that corresponding for this activity.
     *
     * @return set of the intent filter
     */
    @XmlElement(name = "intent-filter",
            namespace = AbstractInfo.MANIFEST_NAMESPACE)
    public final Set getIntentFilters() {
        return filters;
    }

    /**
     * Retrieve activity package information.
     *
     * @return an activity package information
     */
    @XmlTransient
    public final PackageInfo getPackageInfo() {
        return packageInfo;
    }

    /**
     * Sets activity package information.
     *
     * @param info an activity package information
     */
    public final void setPackageInfo(final PackageInfo info) {
        packageInfo = info;
    }

    /**
     * Package information is not restored on unmarshal, so this method should
     * help.
     *
     * @param unmarshaller an instance of the unmarshaller
     * @param parent       parent object
     */
    @SuppressWarnings("unused")
    public final void afterUnmarshal(final Unmarshaller unmarshaller,
                                     final Object parent) {
        packageInfo = (PackageInfo) parent;
    }

    /* (non-Javadoc)
     * @see java.lang.Object#equals(java.lang.Object)
     */
    @Override
    public boolean equals(final Object object) {
        boolean areEquals;
        if (this == object) {
            areEquals = true;
        } else {
            if (object instanceof AbstractInfo) {
                final AbstractInfo that = (AbstractInfo) object;
                areEquals = Objects.equals(className, that.className);
            } else {
                areEquals = false;
            }
        }
        return areEquals;
    }

    /* (non-Javadoc)
     * @see java.lang.Object#hashCode()
     */
    @Override
    public int hashCode() {
        return Objects.hash(className);
    }

    /* (non-Javadoc)
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        final String packageName;
        if (packageInfo == null) {
            packageName = null;
        } else {
            packageName = packageInfo.getName();
        }
        return String.format("AbstractInfo { class='%s', package='%s' }",
                className, packageName);
    }
}