1 package org.apache.maven.doxia.book;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import org.apache.maven.doxia.book.services.validation.ValidationResult;
23
24 /**
25 * Indicates that the book descriptor file could not be parsed correctly.
26 *
27 * @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
28 * @version $Id: InvalidBookDescriptorException.java 769433 2009-04-28 15:26:55Z ltheussl $
29 */
30 public class InvalidBookDescriptorException
31 extends BookDoxiaException
32 {
33
34 /** serialVersionUID */
35 private static final long serialVersionUID = -5706648416915909753L;
36
37 /** ValidationResult. */
38 private ValidationResult validationResult;
39
40 /**
41 * Construct a new InvalidBookDescriptorException and stores the given ValidationResult.
42 *
43 * @param validationResult The ValidationResult to store.
44 */
45 public InvalidBookDescriptorException( ValidationResult validationResult )
46 {
47 super( "Invalid book descriptor." );
48
49 this.validationResult = validationResult;
50 }
51
52 /**
53 * Return the ValidationResult.
54 *
55 * @return the ValidationResult associated with this Exception.
56 */
57 public ValidationResult getValidationResult()
58 {
59 return validationResult;
60 }
61 }