org.supercsv.cellprocessor.time.ParseLocalTime Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of super-csv-java8 Show documentation
An extension for Super CSV for use with Java 8
The newest version!
/*
 * Copyright 2007 Kasper B. Graversen
 * 
 * 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 org.supercsv.cellprocessor.time;

import java.time.LocalTime;
import java.time.format.DateTimeFormatter;
import java.time.format.DateTimeFormatterBuilder;

import org.supercsv.cellprocessor.ift.CellProcessor;

/**
 * Converts a String to a LocalTime.
 * For constructors using DateTimeFormatter, refer to the following
 * classes:
 * 
 * {@link DateTimeFormatter} - formats by pattern and style
 * {@link DateTimeFormatter} - ISO 8601 formats
 * {@link DateTimeFormatterBuilder} - complex formats created via method
 * calls
 * 
 *
 * @author Ludovico Fischer
 * @since 2.4.0
 */
public class ParseLocalTime extends AbstractTemporalAccessorParsingProcessor {

	/**
	 * Constructs a new ParseLocalTime processor, which parses a
	 * String as a LocalTime, accepting the same format as {@link LocalTime#parse(CharSequence)}
	 *
	 */
	public ParseLocalTime() {
	}

	/**
	 * Constructs a new ParseLocalTime processor, which parses a
	 * String as a LocalTime, then calls the next processor in the
	 * chain.
	 *
	 * @param next the next processor in the chain
	 * @throws NullPointerException if next is null
	 * @see ParseLocalTime()
	 */
	public ParseLocalTime(final CellProcessor next) {
		super(next);
	}

	/**
	 * Constructs a new ParseLocalTime processor, which parses a
	 * String as a LocalTime using the supplied formatter.
	 *
	 * @param formatter the formatter used for parsing
	 * @throws NullPointerException if formatter is null
	 */
	public ParseLocalTime(final DateTimeFormatter formatter) {
		super(formatter);
	}

	/**
	 * Constructs a new ParseLocalTime processor, which parses a
	 * String as a LocalTime using the supplied formatter, then calls
	 * the next processor in the chain.
	 *
	 * @param formatter the formatter used for parsing
	 * @param next      the next processor in the chain
	 * @throws NullPointerException if formatter or next is null
	 */
	public ParseLocalTime(final DateTimeFormatter formatter, final CellProcessor next) {
		super(formatter, next);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	protected LocalTime parse(final String string) {
		return LocalTime.parse(string);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	protected LocalTime parse(final String string, final DateTimeFormatter formatter) {
		return LocalTime.parse(string, formatter);
	}
}