/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to you 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.apache.logging.log4j.core.util.internal.instant;

import static java.util.Objects.requireNonNull;

import java.time.temporal.ChronoUnit;
import org.apache.logging.log4j.core.time.Instant;

/**
 * Contract for formatting {@link Instant}s.
 *
 * @since 2.25.0
 */
public interface InstantFormatter {

    /**
     * @return the time precision of the formatted output
     */
    ChronoUnit getPrecision();

    default String format(final Instant instant) {
        requireNonNull(instant, "instant");
        final StringBuilder buffer = new StringBuilder();
        formatTo(buffer, instant);
        return buffer.toString();
    }

    void formatTo(StringBuilder buffer, Instant instant);
}
