com.helger.commons.mutable.IMutableNumeric Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-commons Show documentation

Java 1.6+ Library with tons of utility classes required in all projects

There is a newer version: 9.5.5

/**
 * Copyright (C) 2014-2016 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed 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 com.helger.commons.mutable;

import java.math.BigDecimal;
import java.math.BigInteger;

import javax.annotation.Nonnull;

/**
 * Base interface for mutable numeric values
 *
 * @author Philip Helger
 * @param 
 *        Implementation type
 */
public interface IMutableNumeric > extends IMutableObject 
{
  /**
   * @return true if the value is 0
   */
  boolean is0 ();

  /**
   * @return true if the value is not 0
   */
  default boolean isNot0 ()
  {
    return !is0 ();
  }

  /**
   * @return true if the value is < 0
   */
  boolean isSmaller0 ();

  /**
   * @return true if the value is ≤ 0
   */
  boolean isSmallerOrEqual0 ();

  /**
   * @return true if the value is > 0
   */
  boolean isGreater0 ();

  /**
   * @return true if the value is ≥ 0
   */
  boolean isGreaterOrEqual0 ();

  @Nonnull
  Byte getAsByte ();

  @Nonnull
  Character getAsCharacter ();

  @Nonnull
  Double getAsDouble ();

  @Nonnull
  Float getAsFloat ();

  @Nonnull
  Integer getAsInteger ();

  @Nonnull
  Long getAsLong ();

  @Nonnull
  Short getAsShort ();

  @Nonnull
  BigInteger getAsBigInteger ();

  @Nonnull
  BigDecimal getAsBigDecimal ();
}