View Javadoc

1   /*
2    * $Id$
3    */
4   
5   package org.apache.maven.model;
6   
7     //---------------------------------/
8    //- Imported classes and packages -/
9   //---------------------------------/
10  
11  import java.util.Date;
12  
13  /**
14   * Describes where an artifact has moved to. If any of the values
15   * are omitted, it is
16   *         assumed to be the same as it was before.
17   * 
18   * @version $Revision$ $Date$
19   */
20  public class Relocation implements java.io.Serializable {
21  
22  
23        //--------------------------/
24       //- Class/Member Variables -/
25      //--------------------------/
26  
27      /**
28       * The group ID the artifact has moved to.
29       */
30      private String groupId;
31  
32      /**
33       * The new artifact ID of the artifact.
34       */
35      private String artifactId;
36  
37      /**
38       * The new version of the artifact.
39       */
40      private String version;
41  
42      /**
43       * An additional message to show the user about the move, such
44       * as the reason.
45       */
46      private String message;
47  
48  
49        //-----------/
50       //- Methods -/
51      //-----------/
52  
53      /**
54       * Get the new artifact ID of the artifact.
55       * 
56       * @return String
57       */
58      public String getArtifactId()
59      {
60          return this.artifactId;
61      } //-- String getArtifactId() 
62  
63      /**
64       * Get the group ID the artifact has moved to.
65       * 
66       * @return String
67       */
68      public String getGroupId()
69      {
70          return this.groupId;
71      } //-- String getGroupId() 
72  
73      /**
74       * Get an additional message to show the user about the move,
75       * such as the reason.
76       * 
77       * @return String
78       */
79      public String getMessage()
80      {
81          return this.message;
82      } //-- String getMessage() 
83  
84      /**
85       * Get the new version of the artifact.
86       * 
87       * @return String
88       */
89      public String getVersion()
90      {
91          return this.version;
92      } //-- String getVersion() 
93  
94      /**
95       * Set the new artifact ID of the artifact.
96       * 
97       * @param artifactId
98       */
99      public void setArtifactId( String artifactId )
100     {
101         this.artifactId = artifactId;
102     } //-- void setArtifactId( String ) 
103 
104     /**
105      * Set the group ID the artifact has moved to.
106      * 
107      * @param groupId
108      */
109     public void setGroupId( String groupId )
110     {
111         this.groupId = groupId;
112     } //-- void setGroupId( String ) 
113 
114     /**
115      * Set an additional message to show the user about the move,
116      * such as the reason.
117      * 
118      * @param message
119      */
120     public void setMessage( String message )
121     {
122         this.message = message;
123     } //-- void setMessage( String ) 
124 
125     /**
126      * Set the new version of the artifact.
127      * 
128      * @param version
129      */
130     public void setVersion( String version )
131     {
132         this.version = version;
133     } //-- void setVersion( String ) 
134 
135 
136     private String modelEncoding = "UTF-8";
137 
138     /**
139      * Set an encoding used for reading/writing the model.
140      *
141      * @param modelEncoding the encoding used when reading/writing the model.
142      */
143     public void setModelEncoding( String modelEncoding )
144     {
145         this.modelEncoding = modelEncoding;
146     }
147 
148     /**
149      * @return the current encoding used when reading/writing this model.
150      */
151     public String getModelEncoding()
152     {
153         return modelEncoding;
154     }
155 }