com.github.jknack.handlebars.HandlebarsError Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation

The Adobe Experience Manager SDK

There is a newer version: 2024.11.18751.20241128T090041Z-241100

/**
 * Copyright (c) 2012-2015 Edgar Espina
 *
 * This file is part of Handlebars.java.
 *
 * 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 com.github.jknack.handlebars;

import java.io.Serializable;
import static org.apache.commons.lang3.Validate.isTrue;
import static org.apache.commons.lang3.Validate.notEmpty;

/**
 *  Useful information about a handlebar error.
 *
 *  @author edgar.espina
 *  @since 0.5.0
 *
 * @deprecated com.github.jknack.handlebars package is deprecated and marked for removal in subsequent releases which will involve removal of the handlebars dependency in AEM.
 */
@Deprecated(since = "2024-07-10")
public class HandlebarsError implements Serializable {

    /**
     * The error's line number.
     */
    public final int line;

    /**
     * The error's column number.
     */
    public final int column;

    /**
     * The error's problem.
     */
    public final String reason;

    /**
     * The error's evidence.
     */
    public final String evidence;

    /**
     * The file's name.
     */
    public final String filename;

    /**
     * The full error's message.
     */
    public final String message;

    /**
     * Creates a new {@link HandlebarsError}.
     *
     * @param filename The file's name. Required.
     * @param line The error's line number.
     * @param column The error's column number.
     * @param reason The error's reason. Required.
     * @param evidence The error's evidence. Required.
     * @param message The error's message. Required.
     */
    public HandlebarsError(final String filename, final int line, final int column, final String reason, final String evidence, final String message) {
        this.filename = notEmpty(filename, "The file's name is required");
        isTrue(line > 0, "The error's line number must be greater than zero");
        this.line = line;
        isTrue(column > 0, "The error's column number must be greater than zero");
        this.column = column;
        this.reason = notEmpty(reason, "The file's reason is required");
        this.evidence = notEmpty(evidence, "The file's evidence is required");
        this.message = notEmpty(message, "The file's message is required");
    }

    @Override
    public String toString() {
        return message;
    }
}