/*
 * $Id$
 *
 * SARL is an general-purpose agent programming language.
 * More details on http://www.sarl.io
 *
 * Copyright (C) 2014-2026 SARL.io, the original authors and main 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
 *
 *      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 io.sarl.docs.generator.parser;

import java.text.MessageFormat;

/** An anchor is not valid.
 *
 * @author $Author: sgalland$
 * @version $FullVersion$
 * @mavengroupid $GroupId$
 * @mavenartifactid $ArtifactId$
 * @since 0.7
 */
public class InvalidAnchorLabelException extends RuntimeException {

	private static final long serialVersionUID = 4282853898682563456L;

	private final String anchor;

	private final int line;

	/** Constructor.
	 *
	 * @param anchor the failing anchor.
	 * @param line the number of the line at which the error occurs.
	 * @param existingAnchors the set of existing anchors.
	 * @since 0.12
	 */
	public InvalidAnchorLabelException(String anchor, int line, String... existingAnchors) {
		super(errorMessage(anchor, line, existingAnchors));
		this.anchor = anchor;
		this.line = line;
	}

	private static String errorMessage(String anchor, int line, String... existingAnchors) {
		if (line < 0) {
			return MessageFormat.format(Messages.InvalidAnchorLabelException_1, anchor, format(existingAnchors));
		}
		return MessageFormat.format(Messages.InvalidAnchorLabelException_0, anchor, Integer.toString(line), format(existingAnchors));
	}

	private static String format(String[] anchors) {
		final var builder = new StringBuilder();
		for (final var anchor : anchors) {
			if (builder.length() > 0) {
				builder.append(", "); //$NON-NLS-1$
			}
			builder.append(anchor);
		}
		return builder.toString();
	}

	/** Replies the failing anchor.
	 *
	 * @return the anchor.
	 */
	public String getAnchor() {
		return this.anchor;
	}

	/** Replies the line at which the failing anchor is located.
	 *
	 * @return the line number.
	 * @since 0.12
	 */
	public int getLine() {
		return this.line;
	}

}
