1 package org.apache.maven.doxia.book.services.validation;
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.model.BookModel;
23
24 /**
25 * Ensure a BookModel is valid.
26 *
27 * @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
28 * @version $Id: BookValidator.java 638290 2008-03-18 09:45:22Z bentmann $
29 */
30 public interface BookValidator
31 {
32 /** The plexus lookup role. */
33 String ROLE = BookValidator.class.getName();
34
35 /**
36 * Validate a BookModel.
37 *
38 * @param book the BookModel to validate.
39 * @return ValidationResult
40 */
41 ValidationResult validateBook( BookModel book );
42 }