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.juneau.commons.template;
018
019import java.util.*;
020import java.util.function.*;
021
022/**
023 * Pairs a value encoder with a {@link StructureRenderer} for one output format.
024 *
025 * <p>
026 * See {@link Destinations} for the presets.  Consumers can define their own.
027 *
028 * @param name A short name for diagnostics.
029 * @param encoder Escapes one resolved value for the format.  Must accept the empty string and never return <jk>null</jk>.
030 * @param renderer Renders lists, blocks and tables for the format.
031 */
032public record Destination(String name, UnaryOperator<String> encoder, StructureRenderer renderer) {
033
034   /** Constructor. */
035   public Destination {
036      Objects.requireNonNull(name, "name must not be null");
037      Objects.requireNonNull(encoder, "encoder must not be null");
038      Objects.requireNonNull(renderer, "renderer must not be null");
039   }
040}