rife2-template-renderers/src/main/java/rife/render/Year.java

52 lines
1.7 KiB
Java

/*
* Copyright 2023-2024 the original author or authors.
*
* 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
*
* https://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 rife.render;
import rife.template.Template;
import rife.template.ValueRenderer;
import java.time.ZonedDateTime;
/**
* <p>Renders the current year.</p>
*
* <p>Usage:</p>
*
* <pre>
* &lt;!--v render:rife.render.Year/--&gt;
* {{v render:rife.render.Year/}}
* </pre>
*
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.rennder.Year">rife.render.Year</a>
* @since 1.0
*/
public class Year implements ValueRenderer {
/**
* Renders the current year.
*
* @param template the template that is currently being rendered
* @param valueId the id of the value to render
* @param differentiator a differentiator that may be used to differentiate the rendering of this value renderer
* @return the current year
*/
@Override
public String render(Template template, String valueId, String differentiator) {
return template.getEncoder().encode(ZonedDateTime.now().format(RenderUtils.ISO_8601_YEAR_FORMATTER));
}
}