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.8+ Library with tons of utility classes required in all projects

There is a newer version: 11.1.10

/*
 * Copyright (C) 2014-2022 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 , INumber
{
  /**
   * @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 isLT0 ();

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

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

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

  @Nonnull
  default Byte getAsByte ()
  {
    return Byte.valueOf (byteValue ());
  }

  @Nonnull
  default Character getAsCharacter ()
  {
    return Character.valueOf ((char) intValue ());
  }

  @Nonnull
  default Double getAsDouble ()
  {
    return Double.valueOf (doubleValue ());
  }

  @Nonnull
  default Float getAsFloat ()
  {
    return Float.valueOf (floatValue ());
  }

  @Nonnull
  default Integer getAsInteger ()
  {
    return Integer.valueOf (intValue ());
  }

  @Nonnull
  default Long getAsLong ()
  {
    return Long.valueOf (longValue ());
  }

  @Nonnull
  default Short getAsShort ()
  {
    return Short.valueOf (shortValue ());
  }

  @Nonnull
  default BigInteger getAsBigInteger ()
  {
    return BigInteger.valueOf (longValue ());
  }

  @Nonnull
  default BigDecimal getAsBigDecimal ()
  {
    return BigDecimal.valueOf (doubleValue ());
  }

}