View Javadoc

1   package org.apache.maven.plugin.ear;
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.codehaus.plexus.util.WriterFactory;
23  import org.codehaus.plexus.util.xml.PrettyPrintXMLWriter;
24  import org.codehaus.plexus.util.xml.XMLWriter;
25  
26  import java.io.File;
27  import java.io.IOException;
28  import java.io.Writer;
29  
30  /**
31   * A base class for deployment descriptor file generators.
32   * 
33   * @author <a href="snicoll@apache.org">Stephane Nicoll</a>
34   * @version $Id: AbstractXmlWriter.java 1542508 2013-11-16 13:21:35Z rfscholte $
35   */
36  abstract class AbstractXmlWriter
37  {
38  
39      private final String encoding;
40  
41      protected static final String MODULE_ELEMENT = "module";
42  
43      protected static final String SERVICE_ELEMENT = "service";
44  
45      AbstractXmlWriter( String encoding )
46      {
47          this.encoding = encoding;
48      }
49  
50      protected Writer initializeWriter( final File destinationFile )
51          throws EarPluginException
52      {
53          try
54          {
55              return WriterFactory.newXmlWriter( destinationFile );
56          }
57          catch ( IOException ex )
58          {
59              throw new EarPluginException( "Exception while opening file[" + destinationFile.getAbsolutePath() + "]", ex );
60          }
61      }
62  
63      protected XMLWriter initializeXmlWriter( final Writer writer, final String docType )
64      {
65          return new PrettyPrintXMLWriter( writer, encoding, docType );
66      }
67  
68      protected void close( Writer closeable )
69      {
70          if ( closeable == null )
71          {
72              return;
73          }
74  
75          try
76          {
77              closeable.close();
78          }
79          catch ( Exception e )
80          {
81              // TODO: warn
82          }
83      }
84  
85      public String getEncoding()
86      {
87          return encoding;
88      }
89  }