atom.app.ActivityList 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.app;
import atom.content.Intent;
import java.io.Serializable;
import java.util.Arrays;
/**
* An activity list that used for simplification of the usage activity' array.
*
* @author Alex Voloshyn
* @author Serge Voloshyn
* @version 1.6 1/15/15
*/
public final class ActivityList implements Serializable {
/**
* Use serialVersionUID from JDK 1.0.2 for interoperability.
*/
private static final long serialVersionUID = 5446316810559497140L;
/**
* Activities in the list.
*/
private final Activity[] activities
= new Activity[Intent.LAYER_MAX_COUNT];
/**
* Actual activities count in the list.
*/
private int size = 0;
/**
* New Activity List.
*/
public ActivityList() {
super();
}
/**
* Clean list and destroy activities.
*/
public void destroy() {
for (int i = 0; i < Intent.LAYER_MAX_COUNT; i++) {
final Activity activity = activities[i];
if (activity != null) {
activity.onDestroy();
set(i, null);
}
}
}
/**
* Retrieve current activity for layer.
*
* Throws IllegalArgumentException if layer index is out of allowed layers.
*
* @param layer layer index
* @return an activity that currently processed within layer
*/
public Activity get(final int layer) {
try {
return activities[layer];
} catch (final IndexOutOfBoundsException outRange) {
throw new IllegalArgumentException(
String.format("Illegal layer index '%d' "
+ "is being used to retrieve activity."
+ " Allowed layers indexes are '0...%d'",
layer, Intent.LAYER_MAX_COUNT - 1));
}
}
/**
* Sets an activity that currently used by user.
*
* Throws IllegalArgumentException if layer index is out of allowed layers.
*
* @param layer of a currently processed activity
* @param activity an activity that currently processed
*/
public void set(final int layer, final Activity activity) {
try {
if (activities[layer] == null && activity != null) {
++size;
} else if (activities[layer] != null && activity == null) {
--size;
}
activities[layer] = activity;
} catch (final IndexOutOfBoundsException outRange) {
throw new IllegalArgumentException(
String.format("Illegal layer index '%d'"
+ " is being used for Activity '%s'."
+ " Allowed layers indexes are '0...%d'",
layer, activity,
Intent.LAYER_MAX_COUNT - 1));
}
}
/**
* Retrieve current activity for layer and remove it from list.
*
* Throws IllegalArgumentException if layer index is out of allowed layers.
*
* @param layer layer index
* @return an activity that currently processed within layer
*/
public Activity remove(final int layer) {
final Activity result = get(layer);
set(layer, null);
return result;
}
/**
* Returns total length of the list.
*
* @return total length of the list
*/
public int length() {
return activities.length;
}
/**
* Whether there is any activity in the list.
*
* @return whether there is any activity in the list
*/
public boolean isEmpty() {
return size == 0;
}
@Override
public boolean equals(final Object object) {
boolean areEquals;
if (this == object) {
areEquals = true;
} else {
if (object instanceof ActivityList) {
final ActivityList that = (ActivityList) object;
areEquals = Arrays.equals(activities, that.activities);
} else {
areEquals = false;
}
}
return areEquals;
}
@Override
public int hashCode() {
return Arrays.hashCode(activities);
}
@Override
public String toString() {
return Arrays.toString(activities);
}
}