All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.joda.time.format.DateTimePrinter Maven / Gradle / Ivy

There is a newer version: 2.12.15
Show newest version
/*
 *  Copyright 2001-2014 Stephen Colebourne
 *
 *  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.joda.time.format;

import java.io.IOException;
import java.io.Writer;
import java.util.Locale;

import org.joda.time.Chronology;
import org.joda.time.DateTimeZone;
import org.joda.time.ReadablePartial;

/**
 * Internal interface for creating textual representations of datetimes.
 * 

* Application users will rarely use this class directly. Instead, you * will use one of the factory classes to create a {@link DateTimeFormatter}. *

* The factory classes are:
* - {@link DateTimeFormatterBuilder}
* - {@link DateTimeFormat}
* - {@link ISODateTimeFormat}
* * @author Brian S O'Neill * @author Stephen Colebourne * @see DateTimeFormatterBuilder * @see DateTimeFormat * @see ISODateTimeFormat * @since 1.0 */ public interface DateTimePrinter { /** * Returns the expected maximum number of characters produced. * The actual amount should rarely exceed this estimate. * * @return the estimated length */ int estimatePrintedLength(); //----------------------------------------------------------------------- /** * Prints an instant from milliseconds since 1970-01-01T00:00:00Z, * using the given Chronology. * * @param buf formatted instant is appended to this buffer, not null * @param instant millis since 1970-01-01T00:00:00Z * @param chrono the chronology to use, not null * @param displayOffset if a time zone offset is printed, force it to use * this millisecond value * @param displayZone the time zone to use, null means local time * @param locale the locale to use, null means default locale */ void printTo(StringBuffer buf, long instant, Chronology chrono, int displayOffset, DateTimeZone displayZone, Locale locale); /** * Prints an instant from milliseconds since 1970-01-01T00:00:00Z, * using the given Chronology. * * @param out formatted instant is written out, not null * @param instant millis since 1970-01-01T00:00:00Z * @param chrono the chronology to use, not null * @param displayOffset if a time zone offset is printed, force it to use * this millisecond value * @param displayZone the time zone to use, null means local time * @param locale the locale to use, null means default locale */ void printTo(Writer out, long instant, Chronology chrono, int displayOffset, DateTimeZone displayZone, Locale locale) throws IOException; //----------------------------------------------------------------------- /** * Prints a ReadablePartial. * * @param buf formatted partial is appended to this buffer, not null * @param partial partial to format, not null * @param locale the locale to use, null means default locale */ void printTo(StringBuffer buf, ReadablePartial partial, Locale locale); /** * Prints a ReadablePartial. * * @param out formatted partial is written out, not null * @param partial partial to format, not null * @param locale the locale to use, null means default locale */ void printTo(Writer out, ReadablePartial partial, Locale locale) throws IOException; }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy