001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.logging.log4j.core.util.datetime;
018
019import java.text.FieldPosition;
020import java.text.ParseException;
021import java.text.ParsePosition;
022
023/**
024 * The basic methods for performing date formatting.
025 */
026public abstract class Format {
027
028    public final String format (final Object obj) {
029        return format(obj, new StringBuilder(), new FieldPosition(0)).toString();
030    }
031
032    public abstract StringBuilder format(Object obj, StringBuilder toAppendTo, FieldPosition pos);
033
034    public abstract Object parseObject (String source, ParsePosition pos);
035
036    public Object parseObject(final String source) throws ParseException {
037        final ParsePosition pos = new ParsePosition(0);
038        final Object result = parseObject(source, pos);
039        if (pos.getIndex() == 0) {
040            throw new ParseException("Format.parseObject(String) failed", pos.getErrorIndex());
041        }
042        return result;
043    }
044}