com.helger.commons.lang.TimeValue 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.lang;

import java.util.concurrent.TimeUnit;

import javax.annotation.Nonnull;
import javax.annotation.concurrent.Immutable;

import com.helger.commons.ValueEnforcer;
import com.helger.commons.hashcode.HashCodeGenerator;
import com.helger.commons.string.ToStringGenerator;

/**
 * Pair of {@link TimeUnit} and a value.
 *
 * @author Philip Helger
 */
@Immutable
public class TimeValue
{
  /** Special instance representing 1 second */
  public static final TimeValue SEC1 = new TimeValue (TimeUnit.SECONDS, 1);

  private final TimeUnit m_eTimeUnit;
  private final long m_nDuration;

  public TimeValue (@Nonnull final TimeUnit eTimeUnit, final long nDuration)
  {
    ValueEnforcer.notNull (eTimeUnit, "TimeUnit");
    m_eTimeUnit = eTimeUnit;
    m_nDuration = nDuration;
  }

  @Nonnull
  public TimeUnit getTimeUnit ()
  {
    return m_eTimeUnit;
  }

  public long getDuration ()
  {
    return m_nDuration;
  }

  public long getAsNanos ()
  {
    return m_eTimeUnit.toNanos (m_nDuration);
  }

  public long getAsMicros ()
  {
    return m_eTimeUnit.toMicros (m_nDuration);
  }

  public long getAsMillis ()
  {
    return m_eTimeUnit.toMillis (m_nDuration);
  }

  public long getAsSeconds ()
  {
    return m_eTimeUnit.toSeconds (m_nDuration);
  }

  public long getAsMinutes ()
  {
    return m_eTimeUnit.toMinutes (m_nDuration);
  }

  public long getAsHours ()
  {
    return m_eTimeUnit.toHours (m_nDuration);
  }

  public long getAsDays ()
  {
    return m_eTimeUnit.toDays (m_nDuration);
  }

  @Override
  public boolean equals (final Object o)
  {
    if (o == this)
      return true;
    if (o == null || !getClass ().equals (o.getClass ()))
      return false;
    final TimeValue rhs = (TimeValue) o;
    return m_eTimeUnit.equals (rhs.m_eTimeUnit) && m_nDuration == rhs.m_nDuration;
  }

  @Override
  public int hashCode ()
  {
    return new HashCodeGenerator (this).append (m_eTimeUnit).append (m_nDuration).getHashCode ();
  }

  @Override
  public String toString ()
  {
    return new ToStringGenerator (this).append ("timeUnit", m_eTimeUnit).append ("value", m_nDuration).toString ();
  }
}