JexlInfo.java

/*
* Copyright 2016 Nabarun Mondal
* 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.noga.njexl.lang;

/**
 * Interface for objects carrying information usefull to debugging.
 * @since 1.0
 */
public interface JexlInfo {
    /**
     * Formats this information for debugging purpose.
     * @return a human readable string.
     */
    String debugString();
    /**
     * Gets the underlying debugging information.
     * @return a debug info instance
     * @since 2.1
     */
    DebugInfo debugInfo();
}