| /* |
| * 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 org.apache.uima.analysis_engine; |
| |
| import org.apache.uima.UIMAException; |
| import org.apache.uima.cas.CAS; |
| |
| /** |
| * This exception is thrown by an Analysis Engine when it receives a request to generate results |
| * that it cannot produce. More specifically, this exception is thrown by the Analysis Engine's |
| * {@link AnalysisEngine#process(CAS,ResultSpecification)} method when it is given a |
| * {@link org.apache.uima.analysis_engine.ResultSpecification} that is outside the scope of its |
| * {@link org.apache.uima.resource.metadata.Capability} specification. |
| * |
| * |
| */ |
| public class ResultNotSupportedException extends UIMAException { |
| private static final long serialVersionUID = -3483648897752163432L; |
| |
| /** |
| * Message key for a standard UIMA exception message: "No sequence of AnalysisEngines could be |
| * constructed to satisfy the requested result." |
| */ |
| public static final String NO_SEQUENCE_FOUND = "no_sequence_found"; |
| |
| /** |
| * Creates a new exception with a null message. |
| */ |
| public ResultNotSupportedException() { |
| super(); |
| } |
| |
| /** |
| * Creates a new exception with the specified cause and a null message. |
| * |
| * @param aCause |
| * the original exception that caused this exception to be thrown, if any |
| */ |
| public ResultNotSupportedException(Throwable aCause) { |
| super(aCause); |
| } |
| |
| /** |
| * Creates a new exception with a the specified message. |
| * |
| * @param aResourceBundleName |
| * the base name of the resource bundle in which the message for this exception is |
| * located. |
| * @param aMessageKey |
| * an identifier that maps to the message for this exception. The message may contain |
| * placeholders for arguments as defined by the |
| * {@link java.text.MessageFormat MessageFormat} class. |
| * @param aArguments |
| * The arguments to the message. <code>null</code> may be used if the message has no |
| * arguments. |
| */ |
| public ResultNotSupportedException(String aResourceBundleName, String aMessageKey, |
| Object[] aArguments) { |
| super(aResourceBundleName, aMessageKey, aArguments); |
| } |
| |
| /** |
| * Creates a new exception with the specified message and cause. |
| * |
| * @param aResourceBundleName |
| * the base name of the resource bundle in which the message for this exception is |
| * located. |
| * @param aMessageKey |
| * an identifier that maps to the message for this exception. The message may contain |
| * placeholders for arguments as defined by the |
| * {@link java.text.MessageFormat MessageFormat} class. |
| * @param aArguments |
| * The arguments to the message. <code>null</code> may be used if the message has no |
| * arguments. |
| * @param aCause |
| * the original exception that caused this exception to be thrown, if any |
| */ |
| public ResultNotSupportedException(String aResourceBundleName, String aMessageKey, |
| Object[] aArguments, Throwable aCause) { |
| super(aResourceBundleName, aMessageKey, aArguments, aCause); |
| } |
| |
| /** |
| * Creates a new exception with a message from the {@link #STANDARD_MESSAGE_CATALOG}. |
| * |
| * @param aMessageKey |
| * an identifier that maps to the message for this exception. The message may contain |
| * placeholders for arguments as defined by the |
| * {@link java.text.MessageFormat MessageFormat} class. |
| * @param aArguments |
| * The arguments to the message. <code>null</code> may be used if the message has no |
| * arguments. |
| */ |
| public ResultNotSupportedException(String aMessageKey, Object[] aArguments) { |
| super(aMessageKey, aArguments); |
| } |
| |
| /** |
| * Creates a new exception with the specified cause and a message from the |
| * {@link #STANDARD_MESSAGE_CATALOG}. |
| * |
| * @param aMessageKey |
| * an identifier that maps to the message for this exception. The message may contain |
| * placeholders for arguments as defined by the |
| * {@link java.text.MessageFormat MessageFormat} class. |
| * @param aArguments |
| * The arguments to the message. <code>null</code> may be used if the message has no |
| * arguments. |
| * @param aCause |
| * the original exception that caused this exception to be thrown, if any |
| */ |
| public ResultNotSupportedException(String aMessageKey, Object[] aArguments, Throwable aCause) { |
| super(aMessageKey, aArguments, aCause); |
| } |
| } |