1 package org.apache.maven.doxia.wrapper;
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 java.io.Reader;
23
24 /**
25 * Wrapper for an input reader.
26 *
27 * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
28 * @version $Id: InputReaderWrapper.java 786981 2009-06-21 10:01:58Z ltheussl $
29 */
30 public class InputReaderWrapper
31 extends AbstractWrapper
32 {
33 /** serialVersionUID */
34 static final long serialVersionUID = 3260213754615748766L;
35
36 private Reader reader;
37
38 /**
39 * Private constructor.
40 *
41 * @param format not null
42 * @param supportedFormat not null
43 * @throws IllegalArgumentException if the format equals AUTO_FORMAT.
44 */
45 private InputReaderWrapper( Reader reader, String format, String[] supportedFormat )
46 {
47 super( format, supportedFormat );
48
49 if ( getFormat().equalsIgnoreCase( AUTO_FORMAT ) )
50 {
51 throw new IllegalArgumentException( "input format is required" );
52 }
53
54 if ( reader == null )
55 {
56 throw new IllegalArgumentException( "input reader is required" );
57 }
58 this.reader = reader;
59 }
60
61 /**
62 * @return the reader
63 */
64 public Reader getReader()
65 {
66 return this.reader;
67 }
68
69 /**
70 * @param reader not null
71 * @param format not null
72 * @param supportedFormat not null
73 * @return a type safe input reader
74 */
75 public static InputReaderWrapper valueOf( Reader reader, String format, String[] supportedFormat )
76 {
77 return new InputReaderWrapper( reader, format, supportedFormat );
78 }
79 }