Coverage Report

Coverage Report - org.apache.maven.doxia.book.context.BookContext

Classes in this File

Line Coverage

Branch Coverage

Complexity

BookContext

92%

23/25

100%

2/2

1,059

BookContext$BookFile

100%

6/6

N/A

1,059

 package org.apache.maven.doxia.book.context;
 
 /*
  * 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.
  */
 
 import org.apache.maven.doxia.book.model.BookModel;
 
 import java.io.File;
 import java.util.Locale;
 import java.util.Map;
 import java.util.HashMap;
 
 /**
  * Context to render a book.
  *
  * @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
  * @version $Id: BookContext.java 1090706 2011-04-09 23:15:28Z hboutemy $
  */
 public class BookContext
 {
     /** The BookModel of this context. */
     private BookModel book;
 
     /** The files. */
     private Map<String, BookContext.BookFile> files;
 
     /** The output directory. */
     private File outputDirectory;
 
     /** The BookIndex of this context. */
     private BookIndex index;
 
     /** The Locale used to generate the navigation. */
     private Locale locale;
 
     /** The input encoding used to read Doxia file. */
     private String inputEncoding;
 
     /** The output encoding used to write the renderer files. */
     private String outputEncoding;
 
     // ----------------------------------------------------------------------
     //
     // ----------------------------------------------------------------------
 
     /** Represents a BookFile. */
     public static class BookFile
     {
         /** The file. */
         private File file;
 
         /** The id of the parser. */
         private String parserId;
 
         /**
          * Constructor.
          *
          * @param file the file.
          * @param parserId the parser id.
          */
         public BookFile( File file, String parserId )
         {
             this.file = file;
             this.parserId = parserId;
         }
 
         /**
          * Return the file of this BookFile.
          *
          * @return File.
          */
         public File getFile()
         {
             return file;
         }
 
         /**
          * Return the parserId of this BookFile.
          *
          * @return String.
          */
         public String getParserId()
         {
             return parserId;
         }
     }
 
     // ----------------------------------------------------------------------
     // Accessors
     // ----------------------------------------------------------------------
 
     /**
      * Return the BookModel of this BookContext.
      *
      * @return BookModel.
      */
     public BookModel getBook()
     {
         return book;
     }
 
     /**
      * Set the BookModel of this BookContext.
      *
      * @param book the BookModel.
      */
     public void setBook( BookModel book )
     {
         this.book = book;
     }
 
     /**
      * Return the files of this BookContext.
      *
      * @return Map. A new HashMap is constructed if the current Map is null.
      */
     public Map<String, BookContext.BookFile> getFiles()
     {
         if ( files == null )
         {
             files = new HashMap<String, BookContext.BookFile>();
         }
 
         return files;
     }
 
     /**
      * Set the files of this BookContext.
      *
      * @param files the Map of files.
      */
     public void setFiles( Map<String, BookContext.BookFile> files )
     {
         this.files = files;
     }
 
     /**
      * Return the outputDirectory of this BookContext.
      *
      * @return File.
      */
     public File getOutputDirectory()
     {
         return outputDirectory;
     }
 
     /**
      * Set the outputDirectory of this BookContext.
      *
      * @param outputDirectory the output directory.
      */
     public void setOutputDirectory( File outputDirectory )
     {
         this.outputDirectory = outputDirectory;
     }
 
     /**
      * Return the index of this BookContext.
      *
      * @return BookIndex.
      */
     public BookIndex getIndex()
     {
         return index;
     }
 
     /**
      * Set the index of this BookContext.
      *
      * @param index the index to set.
      */
     public void setIndex( BookIndex index )
     {
         this.index = index;
     }
 
     /**
      * <p>Getter for the field <code>locale</code>.</p>
      *
      * @return the locale
      * @since 1.1
      */
     public Locale getLocale()
     {
         return locale;
     }
 
     /**
      * <p>Setter for the field <code>locale</code>.</p>
      *
      * @param locale the locale to set
      * @since 1.1
      */
     public void setLocale( Locale locale )
     {
         this.locale = locale;
     }
 
     /**
      * <p>Getter for the field <code>inputEncoding</code>.</p>
      *
      * @return the inputEncoding
      * @since 1.1
      */
     public String getInputEncoding()
     {
         return inputEncoding;
     }
 
     /**
      * <p>Setter for the field <code>inputEncoding</code>.</p>
      *
      * @param inputEncoding the inputEncoding to set
      * @since 1.1
      */
     public void setInputEncoding( String inputEncoding )
     {
         this.inputEncoding = inputEncoding;
     }
 
     /**
      * <p>Getter for the field <code>outputEncoding</code>.</p>
      *
      * @return the outputEncoding
      * @since 1.1
      */
     public String getOutputEncoding()
     {
         return outputEncoding;
     }
 
     /**
      * <p>Setter for the field <code>outputEncoding</code>.</p>
      *
      * @param outputEncoding the outputEncoding to set
      * @since 1.1
      */
     public void setOutputEncoding( String outputEncoding )
     {
         this.outputEncoding = outputEncoding;
     }
 }

1		package org.apache.maven.doxia.book.context;
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		import java.io.File;
25		import java.util.Locale;
26		import java.util.Map;
27		import java.util.HashMap;
28
29		/**
30		* Context to render a book.
31		*
32		* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
33		* @version $Id: BookContext.java 1090706 2011-04-09 23:15:28Z hboutemy $
34		*/
35	7	public class BookContext
36		{
37		/** The BookModel of this context. */
38		private BookModel book;
39
40		/** The files. */
41		private Map<String, BookContext.BookFile> files;
42
43		/** The output directory. */
44		private File outputDirectory;
45
46		/** The BookIndex of this context. */
47		private BookIndex index;
48
49		/** The Locale used to generate the navigation. */
50		private Locale locale;
51
52		/** The input encoding used to read Doxia file. */
53		private String inputEncoding;
54
55		/** The output encoding used to write the renderer files. */
56		private String outputEncoding;
57
58		// ----------------------------------------------------------------------
59		//
60		// ----------------------------------------------------------------------
61
62		/** Represents a BookFile. */
63	7	public static class BookFile
64		{
65		/** The file. */
66		private File file;
67
68		/** The id of the parser. */
69		private String parserId;
70
71		/**
72		* Constructor.
73		*
74		* @param file the file.
75		* @param parserId the parser id.
76		*/
77		public BookFile( File file, String parserId )
78	28	{
79	28	this.file = file;
80	28	this.parserId = parserId;
81	28	}
82
83		/**
84		* Return the file of this BookFile.
85		*
86		* @return File.
87		*/
88		public File getFile()
89		{
90	52	return file;
91		}
92
93		/**
94		* Return the parserId of this BookFile.
95		*
96		* @return String.
97		*/
98		public String getParserId()
99		{
100	52	return parserId;
101		}
102		}
103
104		// ----------------------------------------------------------------------
105		// Accessors
106		// ----------------------------------------------------------------------
107
108		/**
109		* Return the BookModel of this BookContext.
110		*
111		* @return BookModel.
112		*/
113		public BookModel getBook()
114		{
115	9	return book;
116		}
117
118		/**
119		* Set the BookModel of this BookContext.
120		*
121		* @param book the BookModel.
122		*/
123		public void setBook( BookModel book )
124		{
125	6	this.book = book;
126	6	}
127
128		/**
129		* Return the files of this BookContext.
130		*
131		* @return Map. A new HashMap is constructed if the current Map is null.
132		*/
133		public Map<String, BookContext.BookFile> getFiles()
134		{
135	108	if ( files == null )
136		{
137	7	files = new HashMap<String, BookContext.BookFile>();
138		}
139
140	108	return files;
141		}
142
143		/**
144		* Set the files of this BookContext.
145		*
146		* @param files the Map of files.
147		*/
148		public void setFiles( Map<String, BookContext.BookFile> files )
149		{
150	0	this.files = files;
151	0	}
152
153		/**
154		* Return the outputDirectory of this BookContext.
155		*
156		* @return File.
157		*/
158		public File getOutputDirectory()
159		{
160	25	return outputDirectory;
161		}
162
163		/**
164		* Set the outputDirectory of this BookContext.
165		*
166		* @param outputDirectory the output directory.
167		*/
168		public void setOutputDirectory( File outputDirectory )
169		{
170	6	this.outputDirectory = outputDirectory;
171	6	}
172
173		/**
174		* Return the index of this BookContext.
175		*
176		* @return BookIndex.
177		*/
178		public BookIndex getIndex()
179		{
180	4	return index;
181		}
182
183		/**
184		* Set the index of this BookContext.
185		*
186		* @param index the index to set.
187		*/
188		public void setIndex( BookIndex index )
189		{
190	7	this.index = index;
191	7	}
192
193		/**
194		* <p>Getter for the field <code>locale</code>.</p>
195		*
196		* @return the locale
197		* @since 1.1
198		*/
199		public Locale getLocale()
200		{
201	9	return locale;
202		}
203
204		/**
205		* <p>Setter for the field <code>locale</code>.</p>
206		*
207		* @param locale the locale to set
208		* @since 1.1
209		*/
210		public void setLocale( Locale locale )
211		{
212	6	this.locale = locale;
213	6	}
214
215		/**
216		* <p>Getter for the field <code>inputEncoding</code>.</p>
217		*
218		* @return the inputEncoding
219		* @since 1.1
220		*/
221		public String getInputEncoding()
222		{
223	24	return inputEncoding;
224		}
225
226		/**
227		* <p>Setter for the field <code>inputEncoding</code>.</p>
228		*
229		* @param inputEncoding the inputEncoding to set
230		* @since 1.1
231		*/
232		public void setInputEncoding( String inputEncoding )
233		{
234	6	this.inputEncoding = inputEncoding;
235	6	}
236
237		/**
238		* <p>Getter for the field <code>outputEncoding</code>.</p>
239		*
240		* @return the outputEncoding
241		* @since 1.1
242		*/
243		public String getOutputEncoding()
244		{
245	4	return outputEncoding;
246		}
247
248		/**
249		* <p>Setter for the field <code>outputEncoding</code>.</p>
250		*
251		* @param outputEncoding the outputEncoding to set
252		* @since 1.1
253		*/
254		public void setOutputEncoding( String outputEncoding )
255		{
256	6	this.outputEncoding = outputEncoding;
257	6	}
258		}