org.apache.wicket.util.value.IntValue Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.ops4j.pax.wicket.service Show documentation

Pax Wicket Service is an OSGi extension of the Wicket framework, allowing for dynamic loading and unloading of Wicket components and pageSources.

There is a newer version: 5.0.0

Show newest version

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.wicket.util.value;

import java.io.Serializable;

import org.apache.wicket.util.lang.Primitives;


/**
 * A base class based on the Java int primitive for value classes that want to
 * implement standard operations on that value without the pain of aggregating an
 * Integer object.
 * 
 * @author Jonathan Locke
 * @since 1.2.6
 */
public class IntValue implements Comparable, Serializable
{
	private static final long serialVersionUID = 1L;

	/** the int value */
	protected final int value;

	/**
	 * Constructor.
	 * 
	 * @param value
	 *            the int value
	 */
	public IntValue(final int value)
	{
		this.value = value;
	}

	/**
	 * @param that
	 *            The object to compare with
	 * @return 0 if equal, -1 if less than or 1 if greater than
	 */
	public final int compareTo(final IntValue that)
	{
		if (value < that.value)
		{
			return -1;
		}

		if (value > that.value)
		{
			return 1;
		}

		return 0;
	}

	/**
	 * Compares this Object to a given Object.
	 * 
	 * @param that
	 *            the Object to compare with
	 * @return 0 if equal, -1 if less than the given Object's value, or 1 if greater
	 *         than given Object's value
	 */
	@Override
	public final boolean equals(final Object that)
	{
		if (that instanceof IntValue)
		{
			return value == ((IntValue)that).value;
		}

		return false;
	}

	/**
	 * Compares this IntValue with a primitive int value.
	 * 
	 * @param value
	 *            the int value to compare with
	 * @return true if this IntValue is greater than the given
	 *         int value
	 */
	public final boolean greaterThan(final int value)
	{
		return this.value > value;
	}

	/**
	 * Compares this IntValue with another IntValue.
	 * 
	 * @param that
	 *            the IntValue to compare with
	 * @return true if this IntValue is greater than the given
	 *         IntValue
	 */
	public final boolean greaterThan(final IntValue that)
	{
		return value > that.value;
	}

	/**
	 * Returns the hash code for this Object.
	 * 
	 * @return hash code for this Object
	 */
	@Override
	public final int hashCode()
	{
		return Primitives.hashCode(value);
	}

	/**
	 * Compares this IntValue with a primitive int value.
	 * 
	 * @param that
	 *            the int value to compare with
	 * @return true if this IntValue is less than the given
	 *         int value
	 */
	public final boolean lessThan(final int that)
	{
		return value < that;
	}

	/**
	 * Compares this IntValue with another IntValue.
	 * 
	 * @param that
	 *            the IntValue to compare with
	 * @return true if this IntValue is less than the given
	 *         IntValue
	 */
	public final boolean lessThan(final IntValue that)
	{
		return value < that.value;
	}

	/**
	 * Converts this LongValue to a String.
	 * 
	 * @return a String representation of this LongValue
	 */
	@Override
	public String toString()
	{
		return String.valueOf(value);
	}
}