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.*;
020
021/**
022 * Thrown by {@link TemplateResolver#validate(String, TemplateCatalog)} when a template has problems.
023 */
024public class TemplateValidationException extends RuntimeException {
025   private static final long serialVersionUID = 1L;
026
027   private final transient List<TemplateProblem> problems;
028
029   /**
030    * Constructor.
031    *
032    * @param problems The problems, in source order.  Must not be empty.
033    */
034   public TemplateValidationException(List<TemplateProblem> problems) {
035      super(message(problems));
036      this.problems = List.copyOf(problems);
037   }
038
039   /**
040    * Returns the problems.
041    *
042    * @return An unmodifiable list, in source order.
043    */
044   public List<TemplateProblem> problems() { return problems; }
045
046   private static String message(List<TemplateProblem> problems) {
047      var sb = new StringBuilder("Template has ").append(problems.size()).append(" problem(s)");
048      for (var p : problems)
049         sb.append("\n  at ").append(p.start()).append('-').append(p.end()).append(": ").append(p.message());
050      return sb.toString();
051   }
052}