UncheckedLexerException.java

/*
 * Copyright (c) 2015-2020, Stein Eldar Johnsen
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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 net.morimekta.lexer;

import net.morimekta.strings.Displayable;

import java.io.UncheckedIOException;

import static java.util.Objects.requireNonNull;

/**
 * Exception representing problems parsing tokens or other problems with
 * returned tokens from the {@link Lexer}, or how a token interacts with
 * other in the whole structure. This exception is not meant to represent
 * problems that solely comes from the interaction between tokens in an
 * otherwise sound document, e.g. where the problem can not be pinned
 * to a single token causing the problem.
 */
public class UncheckedLexerException extends UncheckedIOException implements Displayable {
    /**
     * Make exception cause by secondary problems.
     *
     * @param cause The cause of the exception.
     */
    public UncheckedLexerException(LexerException cause) {
        super(requireNonNull(cause, "cause == null").getMessage(), cause);
    }

    @Override
    public synchronized LexerException getCause() {
        return requireNonNull((LexerException) super.getCause());
    }

    @Override
    public String toString() {
        return getCause().getClass().getSimpleName() + ": " + getMessage();
    }

    @Override
    public String displayString() {
        return getCause().displayString();
    }
}