View Javadoc
1   package org.apache.maven.shared.release.phase;
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.shared.release.ReleaseResult;
23  import org.slf4j.Logger;
24  import org.slf4j.LoggerFactory;
25  
26  /**
27   * Base class for all phases.
28   *
29   * @author <a href="mailto:brett@apache.org">Brett Porter</a>
30   */
31  public abstract class AbstractReleasePhase
32      implements ReleasePhase
33  {
34      private final Logger logger = LoggerFactory.getLogger( getClass() );
35  
36      protected Logger getLogger()
37      {
38          return logger;
39      }
40  
41      /**
42       * <p>logInfo.</p>
43       *
44       * @param result a {@link org.apache.maven.shared.release.ReleaseResult} object
45       * @param message a {@link java.lang.String} object
46       */
47      protected void logInfo( ReleaseResult result, String message )
48      {
49          result.appendInfo( message );
50          getLogger().info( message );
51      }
52  
53      /**
54       * <p>logWarn.</p>
55       *
56       * @param result a {@link org.apache.maven.shared.release.ReleaseResult} object
57       * @param message a {@link java.lang.String} object
58       */
59      protected void logWarn( ReleaseResult result, String message )
60      {
61          result.appendWarn( message );
62          getLogger().warn( message );
63      }
64  
65      /**
66       * <p>logError.</p>
67       *
68       * @param result a {@link org.apache.maven.shared.release.ReleaseResult} object
69       * @param message a {@link java.lang.String} object
70       */
71      protected void logError( ReleaseResult result, String message )
72      {
73          result.appendWarn( message );
74          getLogger().error( message );
75      }
76  
77      /**
78       * <p>logDebug.</p>
79       *
80       * @param result a {@link org.apache.maven.shared.release.ReleaseResult} object
81       * @param message a {@link java.lang.String} object
82       */
83      protected void logDebug( ReleaseResult result, String message )
84      {
85          result.appendDebug( message );
86          getLogger().debug( message );
87      }
88  
89      /**
90       * <p>logDebug.</p>
91       *
92       * @param result a {@link org.apache.maven.shared.release.ReleaseResult} object
93       * @param message a {@link java.lang.String} object
94       * @param e a {@link java.lang.Exception} object
95       */
96      protected void logDebug( ReleaseResult result, String message, Exception e )
97      {
98          result.appendDebug( message, e );
99          getLogger().debug( message, e );
100     }
101 
102     /**
103      * <p>getReleaseResultSuccess.</p>
104      *
105      * @return a {@link org.apache.maven.shared.release.ReleaseResult} object
106      */
107     protected ReleaseResult getReleaseResultSuccess()
108     {
109         ReleaseResult result = new ReleaseResult();
110 
111         result.setResultCode( ReleaseResult.SUCCESS );
112 
113         return result;
114     }
115 }