CQLSyntaxException.java

/*
 * The MIT License
 *
 * Copyright (c) 2016, CloudBees, Inc., Stephen Connolly.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.cloudbees.plugins.credentials.matchers;

/**
 * Represents a syntax error in a CQL expression.
 *
 * @since 2.1.0
 */
public class CQLSyntaxException extends RuntimeException {

    /**
     * The offset in the original expression string where the syntax error was detected.
     */
    private final int offset;

    /**
     * Records a syntax error.
     *
     * @param message the message.
     * @param offset  the offset in the original expression string.
     */
    public CQLSyntaxException(String message, int offset) {
        super(message);
        this.offset = offset;
    }

    /**
     * Returns the offset in the original string where the syntax error was detected.
     *
     * @return the offset.
     */
    public int getOffset() {
        return offset;
    }

}