com.helger.datetime.util.PDTIOHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-datetime Show documentation
Java date time library based on joda time
There is a newer version: 11.1.8
/*
 * Copyright (C) 2014-2024 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.datetime.util;

import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;

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

import com.helger.commons.annotation.PresentForCodeCoverage;
import com.helger.commons.datetime.PDTFactory;
import com.helger.commons.datetime.PDTToString;

/**
 * Some date time specific routines especially helpful for IO.
 *
 * @author Philip Helger
 */
@Immutable
public final class PDTIOHelper
{
  /** Date pattern suitable for generic sorting */
  public static final String PATTERN_DATE = "uuuuMMdd";
  /** Time pattern suitable for generic sorting */
  public static final String PATTERN_TIME = "HHmmss";
  /** Date and time pattern suitable for generic sorting */
  public static final String PATTERN_DATETIME = PATTERN_DATE + '_' + PATTERN_TIME;

  @PresentForCodeCoverage
  private static final PDTIOHelper INSTANCE = new PDTIOHelper ();

  private PDTIOHelper ()
  {}

  /**
   * @return The current local date time formatted for usage in a file name. It
   *         uses the pattern YYYYMMDD_HHMMSS.
   */
  @Nonnull
  public static String getCurrentLocalDateTimeForFilename ()
  {
    return getLocalDateTimeForFilename (PDTFactory.getCurrentLocalDateTime ());
  }

  /**
   * Get the passed local date time formatted suitable for a file name. It uses
   * the pattern YYYYMMDD_HHMMSS.
   *
   * @param aDT
   *        The local date time to be formatted. May not be null.
   * @return The formatted string.
   */
  @Nonnull
  public static String getLocalDateTimeForFilename (@Nonnull final LocalDateTime aDT)
  {
    return PDTToString.getAsString (PATTERN_DATETIME, aDT);
  }

  /**
   * @return The current date formatted for usage in a file name. It uses the
   *         pattern YYYYMMDD.
   */
  public static String getCurrentDateForFilename ()
  {
    return getDateForFilename (PDTFactory.getCurrentLocalDate ());
  }

  /**
   * Get the passed date formatted suitable for a file name. It uses the pattern
   * YYYYMMDD.
   *
   * @param aLocalDate
   *        The date to be formatted. May not be null.
   * @return The formatted string.
   */
  public static String getDateForFilename (@Nonnull final LocalDate aLocalDate)
  {
    return PDTToString.getAsString (PATTERN_DATE, aLocalDate);
  }

  /**
   * @return The current time formatted for usage in a file name. It uses the
   *         pattern HHMMSS.
   */
  public static String getCurrentTimeForFilename ()
  {
    return getTimeForFilename (PDTFactory.getCurrentLocalTime ());
  }

  /**
   * Get the passed time formatted suitable for a file name. It uses the pattern
   * HHMMSS.
   *
   * @param aLocalTime
   *        The time to be formatted. May not be null.
   * @return The formatted string.
   */
  public static String getTimeForFilename (@Nonnull final LocalTime aLocalTime)
  {
    return PDTToString.getAsString (PATTERN_TIME, aLocalTime);
  }
}