Problem.java

/*
 * ModeShape (http://www.modeshape.org)
 *
 * 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 org.modeshape.jcr.api;

/**
 * An immutable representation of a problem, with a code, message, and an optional exception.
 */
public interface Problem {

    /**
     * Get the message written in the current locale.
     * 
     * @return the message; never null
     */
    String getMessage();

    /**
     * Get the exception that caused this problem.
     * 
     * @return the exception, or null if no exception caused this problem
     */
    Throwable getThrowable();

}