1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
/**
* @copyright
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
* ====================================================================
* @endcopyright
*/
package org.apache.subversion.javahl.types;
import org.apache.subversion.javahl.SubversionException;
/**
* Describes one external item declaration
* @since 1.9
*/
public class ExternalItem implements java.io.Serializable
{
// Update the serialVersionUID when there is a incompatible change made to
// this class. See the java documentation for when a change is incompatible.
// http://java.sun.com/javase/7/docs/platform/serialization/spec/version.html#6678
private static final long serialVersionUID = 1L;
/**
* Create a new external item declaration.
* <p>
* <b>Note:</b> If both <code>revision</code> and
* <code>pegRevision</code> are <code>null</code>, they will be
* interpreted as {@link Revision#HEAD}. If only one of them is
* <code>null</code>, it will get the same value as the other
* revision.
*
* @param targetDir See {@link #getTargetDir}
* @param url See {@link #getUrl}
* @param revision See {@link #getRevision};
* <code>null</code> will be interpreted as <code>pegRevision</code>
* @param pegRevision See {@link #getPegRevision};
* <code>null</code> will be interpreted as {@link Revision#HEAD}
*/
public ExternalItem(String targetDir, String url,
Revision revision, Revision pegRevision)
throws SubversionException
{
this(false, targetDir, url, revision, pegRevision);
validateRevision(revision, "revision");
validateRevision(pegRevision, "pegRevision");
}
/* This constructor is called directly by the native implementation */
private ExternalItem(boolean dummy_parameter_to_discriminate_constructors,
String targetDir, String url,
Revision revision, Revision pegRevision)
{
this.targetDir = targetDir;
this.url = url;
this.pegRevision = (pegRevision != null ? pegRevision : Revision.HEAD);
this.revision = (revision != null ? revision : this.pegRevision);
}
/**
* The name of the subdirectory into which this external should be
* checked out. This is relative to the parent directory that
* holds this external item.
*/
public String getTargetDir()
{
return targetDir;
}
/**
* Where to check out from. This is possibly a relative external
* URL, as allowed in externals definitions, but without the peg
* revision.
*/
public String getUrl()
{
return url;
}
/**
* What revision to check out. The only valid kinds for this are a
* numered revision {@link Revision.Number}, a date
* {@link Revision.DateSpec}, or {@link Revision#HEAD}.
*/
public Revision getRevision()
{
return revision;
}
/**
* The peg revision to use when checking out. The only valid kinds
* for this are a numered revision {@link Revision.Number}, a date
* {@link Revision.DateSpec}, or {@link Revision#HEAD}.
*/
public Revision getPegRevision()
{
return pegRevision;
}
/**
* Compare to another external item.
*/
public boolean equals(Object obj) {
if (this == obj)
return true;
if (!(obj instanceof ExternalItem))
return false;
final ExternalItem that = (ExternalItem)obj;
return (this.targetDir.equals(that.targetDir)
&& this.url.equals(that.url)
&& this.revision.equals(that.revision)
&& this.pegRevision.equals(that.pegRevision));
}
/**
* Return a hash code for this object.
*/
public int hashCode()
{
int hash = 17;
hash = hash * 33 + (null != targetDir ? targetDir.hashCode() : 0);
hash = hash * 33 + (null != url ? url.hashCode() : 0);
hash = hash * 33 + (null != revision ? revision.hashCode() : 0);
hash = hash * 33 + (null != pegRevision ? pegRevision.hashCode() : 0);
return hash;
}
/* Exception class for failed revision kind validation. */
private static class BadRevisionKindException extends SubversionException
{
// Update the serialVersionUID when there is a incompatible change made to
// this class. See the java documentation for when a change is incompatible.
// http://java.sun.com/javase/7/docs/platform/serialization/spec/version.html#6678
private static final long serialVersionUID = 1L;
public BadRevisionKindException(String param)
{
super("the '" + param + "' constructor argument" +
" must be a date, a number, or Revision.HEAD");
}
}
/* Validates the revision and pegRevision parameters of the ctor. */
private static void validateRevision(Revision revision, String param)
throws SubversionException
{
if (revision != null
&& revision.getKind() != Revision.Kind.number
&& revision.getKind() != Revision.Kind.date
&& revision.getKind() != Revision.Kind.head)
throw new BadRevisionKindException(param);
}
private String targetDir;
private String url;
private Revision revision;
private Revision pegRevision;
}
|
