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 1636449 2014-11-03 21:27:36Z khmarbaise $
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 // CHECKSTYLE_OFF: LineLength
60 throw new EarPluginException( "Exception while opening file[" + destinationFile.getAbsolutePath() + "]", ex );
61 // CHECKSTYLE_ON: LineLength
62 }
63 }
64
65 protected XMLWriter initializeXmlWriter( final Writer writer, final String docType )
66 {
67 return new PrettyPrintXMLWriter( writer, encoding, docType );
68 }
69
70 protected void close( Writer closeable )
71 {
72 if ( closeable == null )
73 {
74 return;
75 }
76
77 try
78 {
79 closeable.close();
80 }
81 catch ( Exception e )
82 {
83 // TODO: warn
84 }
85 }
86
87 public String getEncoding()
88 {
89 return encoding;
90 }
91 }