atom.content.ComponentId Maven / Gradle / Ivy
/*
* Copyright © 2015 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;
import java.io.Serializable;
import java.util.Objects;
/**
* Identifier for a specific application component
* ({@link atom.app.Activity} that is available. Two pieces of information,
* encapsulated here, are required to identify a component: the package
* (a String) it exists in, and the class (a String) name inside of that
* package.
*
* @author Alex Voloshyn
* @author Serge Voloshyn
* @version 1.2 1/27/15
*/
public final class ComponentId implements Serializable {
/**
* Empty layer value.
*/
public static final int EMPTY_LAYER = -1;
/**
* Serial version UID for serialization.
*/
private static final long serialVersionUID = 5801117117662501083L;
/**
* Error message for defined layer index that doesn't present in the system.
*/
private static final String MSG_LAYER_ILLEGAL =
"Defined layer index '%d' doesn't present in the system.";
/**
* Error message for cases when somebody try set new the package name when
* class name already set.
*/
private static final String MSG_ALD_SET_CLS = "The class name already set.";
/**
* Error message for cases when somebody try set new the package name when
* package name already set.
*/
private static final String MSG_ALD_SET_PKG =
"The package name already set.";
/**
* Error message for cases when somebody try set null or empty
* string to the class name.
*/
private static final String MSG_ILLEGAL_CLS =
"The class name can't be empty.";
/**
* Error message for cases when somebody try set null or empty
* string to the package name.
*/
private static final String MSG_ILLEGAL_PKG =
"The package name can't be empty.";
/**
* The name of the class inside of package that implements the component.
*/
private String className;
/**
* The name of the package that the component exists in.
*/
private String packageName;
/**
* Activity target layer.
*/
private int layer = EMPTY_LAYER;
/**
* Create a new component identifier.
*/
public ComponentId() {
super();
}
/**
* Create a new component identifier with corresponding package name and
* class name.
*
* @param pkg the name of the package that the component exists in
* @param cls the name of the class inside of package that implements
* the component
*/
public ComponentId(final String pkg, final String cls) {
super();
setPackageName(pkg);
setClassName(cls);
}
/**
* Return the name of the class inside of package that implements
* the component.
*
* @return the name of the class inside of package that implements
* the component
*/
public String getClassName() {
return className;
}
/**
* Set the name of the class inside of package that implements
* the component. Can not be null.
*
* @param cls the name of the class inside of package that implements
* the component
*/
public void setClassName(final String cls) {
if (cls == null || cls.trim().isEmpty()) {
throw new IllegalArgumentException(MSG_ILLEGAL_CLS);
}
if (className != null) {
throw new IllegalStateException(MSG_ALD_SET_CLS);
}
className = cls;
}
/**
* Return the package name of this component.
*
* @return the package name of this component
*/
public String getPackageName() {
return packageName;
}
/**
* Set the name of the package that the component exists in. Can not be
* null.
*
* @param pkg the name of the package that the component exists in
*/
public void setPackageName(final String pkg) {
if (pkg == null || pkg.trim().isEmpty()) {
throw new IllegalArgumentException(MSG_ILLEGAL_PKG);
}
if (packageName != null) {
throw new IllegalStateException(MSG_ALD_SET_PKG);
}
packageName = pkg;
}
/**
* Set an activity' layer index.
*
* @param aLayer new activity' layer index
*/
public void setLayer(final int aLayer) {
if (aLayer < 0 || aLayer >= Intent.LAYER_MAX_COUNT) {
throw new IllegalArgumentException(
String.format(MSG_LAYER_ILLEGAL, aLayer));
}
layer = aLayer;
}
/**
* Get activity' layer index.
*
* @return activity' layer index
*/
public int getLayer() {
return layer;
}
@Override
public boolean equals(final Object object) {
boolean areEquals;
if (this == object) {
areEquals = true;
} else {
if (object instanceof ComponentId) {
final ComponentId that = (ComponentId) object;
areEquals = Objects.equals(packageName, that.packageName)
&& Objects.equals(className, that.className)
&& Objects.equals(layer, that.layer);
} else {
areEquals = false;
}
}
return areEquals;
}
@Override
public int hashCode() {
return Objects.hash(packageName, className, layer);
}
@Override
public String toString() {
return String.format(
"ComponentId { packageName='%s', className='%s', layer='%d' }",
packageName, className, layer);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy