1 /*
2 * Copyright 2006-2012 smartics, Kronseder & Reiner GmbH
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package de.smartics.maven.plugin.buildmetadata.scm;
17
18 import java.util.Date;
19
20 /**
21 * Interface to allow different implementations of the revision information. Our
22 * application requires only the string representation.
23 *
24 * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
25 * @version $Revision:591 $
26 */
27 public interface Revision
28 {
29 // ********************************* Fields *********************************
30
31 // --- constants ------------------------------------------------------------
32
33 // ****************************** Initializer *******************************
34
35 // ****************************** Inner Classes *****************************
36
37 // ********************************* Methods ********************************
38
39 // --- get&set --------------------------------------------------------------
40
41 /**
42 * Returns the identifier of the revision.
43 *
44 * @return the identifier of the revision.
45 */
46 String getId();
47
48 /**
49 * Returns the date of the revision. This is the date the revision was checked
50 * in.
51 *
52 * @return the date of the revision.
53 */
54 Date getDate();
55
56 // --- business -------------------------------------------------------------
57
58 /**
59 * Returns the revision information as a {@link String}.
60 *
61 * @return the string representation of the revision.
62 */
63 String toString();
64
65 // --- object basics --------------------------------------------------------
66
67 }