no.api.freemarker.java8.time.AbstractFormatter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of freemarker-java8 Show documentation

A library that extends FreeMarker with support for the Java Date/Time API

The newest version!

/*
 * Copyright (c) 2015-2024 Jakob Vad Nielsen
 *
 * 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 no.api.freemarker.java8.time;

import freemarker.template.TemplateModelException;
import no.api.freemarker.java8.zone.ZoneStrategy;

import java.time.ZoneId;
import java.util.List;

import static no.api.freemarker.java8.time.DateTimeTools.zoneIdLookup;

/**
 * Abstract formatter class.
 * 
 * Adapters supporting formatters will extend this class.
 *
 * @param  The java.time class this formatter handles.
 */
public abstract class AbstractFormatter {

    private final E obj;

    private final ZoneStrategy strategy;

    public AbstractFormatter(E obj, ZoneStrategy strategy) {
        this.obj = obj;
        this.strategy = strategy;
    }

    /**
     * Get the java.time object that should be formated.
     *
     * @return Some java.time object.
     */
    public E getObject() {
        return obj;
    }

    /**
     * Get the Zone strategy to be used when formatting the object.
     *
     * @return The active zone strategy.
     */
    public ZoneStrategy getStrategy() {
        return strategy;
    }

    public ZoneId getTargetZoneId(final List argumentList, ZoneId zoneId) throws TemplateModelException {
        if (zoneId == null) {
            return zoneIdLookup(argumentList, 1).orElse(getStrategy().getZoneId());
        }
        return zoneIdLookup(argumentList, 1).orElse(getStrategy().getZoneId(zoneId));
    }
}