View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.commons.pipeline.driver;
19  
20  /**
21   * Stores the failure tolerance flag for a worker thread. If faultTolerance
22   * is set to CHECKED, {@link org.apache.commons.pipeline.StageException StageException}s thrown by
23   * the {@link org.apache.commons.pipeline.Stage#process(Object)} method will not interrupt queue
24   * processing, but will simply be logged with a severity of ERROR.
25   * If faultTolerance is set to ALL, runtime exceptions will also be
26   * logged and otherwise ignored.
27   *
28   *
29   */
30  public enum FaultTolerance {
31      /**
32       * {@link org.apache.commons.pipeline.StageException StageException}s thrown by
33       * the {@link org.apache.commons.pipeline.Stage#process(Object)} method will interrupt queue
34       * processing and will be logged with a severity of ERROR.
35       */
36      NONE, 
37      /**
38       * {@link org.apache.commons.pipeline.StageException StageException}s thrown by
39       * the {@link org.apache.commons.pipeline.Stage#process(Object)} method will not interrupt queue
40       * processing, but will simply be logged with a severity of ERROR.
41       */
42      CHECKED, 
43      /**
44       * If faultTolerance is set to ALL, runtime exceptions will be
45       * logged and otherwise ignored.
46       */
47      ALL;
48  }