com.phloc.datetime.period.IPeriodProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of phloc-datetime-jdk5 Show documentation

phloc base date and time stuff

The newest version!

/**
 * Copyright (C) 2006-2014 phloc systems
 * http://www.phloc.com
 * office[at]phloc[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.phloc.datetime.period;

import javax.annotation.Nonnull;

import org.joda.time.Period;

/**
 * Interface for objects providing a {@link Period}.
 * 
 * @author Philip Helger
 */
public interface IPeriodProvider
{
  /**
   * @return true if this object can be converted to a
   *         {@link Period}.
   */
  boolean canConvertToPeriod ();

  /**
   * Get the current object as a Joda {@link Period}.
   * 
   * @return The period as a Joda time object. Never null.
   */
  @Nonnull
  Period getAsPeriod ();
}