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 package org.apache.commons.betwixt.io;
18
19 /**
20 * <p>Thrown when bean evaluation finds a cycle reference.</p>
21 *
22 * <p>There are two possible behaviours that <code>Betwixt</code> adopts when
23 * a cycle in the object graph is encountered.
24 *
25 * <p>If <code>ID</code> attributes are being generated,
26 * then the recursion will stop and the <code>IDREF</code> attribute will be
27 * written.
28 * In this case, <em>no exception will be thrown</em>.</p>
29 *
30 * <p>If <code>ID</code> are <strong>not</strong> being generated,
31 * then this exception will be thrown.</p>
32 *
33 * @author <a href="mailto:rdonkin@apache.org">Robert Burrell Donkin</a>
34 * @version $Revision: 438373 $
35 */
36 public class CyclicReferenceException extends RuntimeException {
37
38 /** Message used with empty constructor */
39 private static final String DEFAULT_MESSAGE
40 = "Bean graph contains a cyclic reference";
41
42 /** Construct exception with default message.
43 */
44 public CyclicReferenceException() {
45 super(DEFAULT_MESSAGE);
46 }
47
48 /**
49 * Construct exception with message
50 *
51 * @param message the detailed message string
52 */
53 public CyclicReferenceException(String message) {
54 super(message);
55 }
56 }