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 */
29 public class InputReaderWrapper
30 extends AbstractWrapper
31 {
32 /** serialVersionUID */
33 static final long serialVersionUID = 3260213754615748766L;
34
35 private final Reader reader;
36
37 /**
38 * Private constructor.
39 *
40 * @param format not null
41 * @param supportedFormat not null
42 * @throws IllegalArgumentException if the format equals AUTO_FORMAT.
43 */
44 private InputReaderWrapper( Reader reader, String format, String[] supportedFormat )
45 {
46 super( format, supportedFormat );
47
48 if ( getFormat().equalsIgnoreCase( AUTO_FORMAT ) )
49 {
50 throw new IllegalArgumentException( "input format is required" );
51 }
52
53 if ( reader == null )
54 {
55 throw new IllegalArgumentException( "input reader is required" );
56 }
57 this.reader = reader;
58 }
59
60 /**
61 * @return the reader
62 */
63 public Reader getReader()
64 {
65 return this.reader;
66 }
67
68 /**
69 * @param reader not null
70 * @param format not null
71 * @param supportedFormat not null
72 * @return a type safe input reader
73 */
74 public static InputReaderWrapper valueOf( Reader reader, String format, String[] supportedFormat )
75 {
76 return new InputReaderWrapper( reader, format, supportedFormat );
77 }
78 }