1
|
|
/*
|
2
|
|
* The Apache Software License, Version 1.1
|
3
|
|
*
|
4
|
|
* Copyright (c) 2002 The Apache Software Foundation. All rights
|
5
|
|
* reserved.
|
6
|
|
*
|
7
|
|
* Redistribution and use in source and binary forms, with or without
|
8
|
|
* modification, are permitted provided that the following conditions
|
9
|
|
* are met:
|
10
|
|
*
|
11
|
|
* 1. Redistributions of source code must retain the above copyright
|
12
|
|
* notice, this list of conditions and the following disclaimer.
|
13
|
|
*
|
14
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
15
|
|
* notice, this list of conditions and the following disclaimer in
|
16
|
|
* the documentation and/or other materials provided with the
|
17
|
|
* distribution.
|
18
|
|
*
|
19
|
|
* 3. The end-user documentation included with the redistribution, if
|
20
|
|
* any, must include the following acknowlegement:
|
21
|
|
* "This product includes software developed by the
|
22
|
|
* Apache Software Foundation (http://www.apache.org/)."
|
23
|
|
* Alternately, this acknowlegement may appear in the software itself,
|
24
|
|
* if and wherever such third-party acknowlegements normally appear.
|
25
|
|
*
|
26
|
|
* 4. The names "Ant" and "Apache Software
|
27
|
|
* Foundation" must not be used to endorse or promote products derived
|
28
|
|
* from this software without prior written permission. For written
|
29
|
|
* permission, please contact apache@apache.org.
|
30
|
|
*
|
31
|
|
* 5. Products derived from this software may not be called "Apache"
|
32
|
|
* nor may "Apache" appear in their names without prior written
|
33
|
|
* permission of the Apache Group.
|
34
|
|
*
|
35
|
|
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
|
36
|
|
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
37
|
|
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
38
|
|
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
|
39
|
|
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
40
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
41
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
|
42
|
|
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
43
|
|
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
44
|
|
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
45
|
|
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
46
|
|
* SUCH DAMAGE.
|
47
|
|
* ====================================================================
|
48
|
|
*
|
49
|
|
* This software consists of voluntary contributions made by many
|
50
|
|
* individuals on behalf of the Apache Software Foundation. For more
|
51
|
|
* information on the Apache Software Foundation, please see
|
52
|
|
* <http://www.apache.org/>.
|
53
|
|
*/
|
54
|
|
package org.apache.tools.ant.taskdefs.optional.extension;
|
55
|
|
|
56
|
|
import java.io.File;
|
57
|
|
import java.util.Iterator;
|
58
|
|
import java.util.Vector;
|
59
|
|
import java.util.jar.Manifest;
|
60
|
|
import org.apache.tools.ant.BuildException;
|
61
|
|
import org.apache.tools.ant.Task;
|
62
|
|
|
63
|
|
/**
|
64
|
|
* Checks whether an extension is present in a fileset or an extensionSet.
|
65
|
|
*
|
66
|
|
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
|
67
|
|
* @ant.task name="jarlib-available"
|
68
|
|
*/
|
69
|
|
public class JarLibAvailableTask
|
70
|
|
extends Task
|
71
|
|
{
|
72
|
|
/**
|
73
|
|
* The library to display information about.
|
74
|
|
*/
|
75
|
|
private File m_file;
|
76
|
|
|
77
|
|
/**
|
78
|
|
* Filesets specifying all the librarys
|
79
|
|
* to display information about.
|
80
|
|
*/
|
81
|
|
private final Vector m_extensionSets = new Vector();
|
82
|
|
|
83
|
|
/**
|
84
|
|
* The name of the property to set if extension is available.
|
85
|
|
*/
|
86
|
|
private String m_property;
|
87
|
|
|
88
|
|
/**
|
89
|
|
* The extension that is required.
|
90
|
|
*/
|
91
|
|
private ExtensionAdapter m_extension;
|
92
|
|
|
93
|
|
/**
|
94
|
|
* The name of property to set if extensions are available.
|
95
|
|
*
|
96
|
|
* @param property The name of property to set if extensions is available.
|
97
|
|
*/
|
98
|
0
|
public void setProperty( final String property )
|
99
|
|
{
|
100
|
0
|
m_property = property;
|
101
|
|
}
|
102
|
|
|
103
|
|
/**
|
104
|
|
* The JAR library to check.
|
105
|
|
*
|
106
|
|
* @param file The jar library to check.
|
107
|
|
*/
|
108
|
0
|
public void setFile( final File file )
|
109
|
|
{
|
110
|
0
|
m_file = file;
|
111
|
|
}
|
112
|
|
|
113
|
|
/**
|
114
|
|
* Set the Extension looking for.
|
115
|
|
*
|
116
|
|
* @param extension Set the Extension looking for.
|
117
|
|
*/
|
118
|
0
|
public void addConfiguredExtension( final ExtensionAdapter extension )
|
119
|
|
{
|
120
|
0
|
if( null != m_extension )
|
121
|
|
{
|
122
|
0
|
final String message = "Can not specify extension to " +
|
123
|
|
"search for multiple times.";
|
124
|
0
|
throw new BuildException( message );
|
125
|
|
}
|
126
|
0
|
m_extension = extension;
|
127
|
|
}
|
128
|
|
|
129
|
|
/**
|
130
|
|
* Adds a set of extensions to search in.
|
131
|
|
*
|
132
|
|
* @param extensionSet a set of extensions to search in.
|
133
|
|
*/
|
134
|
0
|
public void addConfiguredExtensionSet( final ExtensionSet extensionSet )
|
135
|
|
{
|
136
|
0
|
m_extensionSets.addElement( extensionSet );
|
137
|
|
}
|
138
|
|
|
139
|
0
|
public void execute()
|
140
|
|
throws BuildException
|
141
|
|
{
|
142
|
0
|
validate();
|
143
|
|
|
144
|
0
|
final Extension test = m_extension.toExtension();
|
145
|
|
|
146
|
|
// Check if list of files to check has been specified
|
147
|
0
|
if( !m_extensionSets.isEmpty() )
|
148
|
|
{
|
149
|
0
|
final Iterator iterator = m_extensionSets.iterator();
|
150
|
0
|
while( iterator.hasNext() )
|
151
|
|
{
|
152
|
0
|
final ExtensionSet extensionSet = (ExtensionSet)iterator.next();
|
153
|
0
|
final Extension[] extensions =
|
154
|
|
extensionSet.toExtensions( getProject() );
|
155
|
0
|
for( int i = 0; i < extensions.length; i++ )
|
156
|
|
{
|
157
|
0
|
final Extension extension = extensions[ i ];
|
158
|
0
|
if( extension.isCompatibleWith( test ) )
|
159
|
|
{
|
160
|
0
|
getProject().setNewProperty( m_property, "true" );
|
161
|
|
}
|
162
|
|
}
|
163
|
|
}
|
164
|
|
}
|
165
|
|
else
|
166
|
|
{
|
167
|
0
|
final Manifest manifest = ExtensionUtil.getManifest( m_file );
|
168
|
0
|
final Extension[] extensions = Extension.getAvailable( manifest );
|
169
|
0
|
for( int i = 0; i < extensions.length; i++ )
|
170
|
|
{
|
171
|
0
|
final Extension extension = extensions[ i ];
|
172
|
0
|
if( extension.isCompatibleWith( test ) )
|
173
|
|
{
|
174
|
0
|
getProject().setNewProperty( m_property, "true" );
|
175
|
|
}
|
176
|
|
}
|
177
|
|
}
|
178
|
|
}
|
179
|
|
|
180
|
|
/**
|
181
|
|
* Validate the tasks parameters.
|
182
|
|
*
|
183
|
|
* @throws BuildException if invalid parameters found
|
184
|
|
*/
|
185
|
0
|
private void validate()
|
186
|
|
throws BuildException
|
187
|
|
{
|
188
|
0
|
if( null == m_extension )
|
189
|
|
{
|
190
|
0
|
final String message = "Extension element must be specified.";
|
191
|
0
|
throw new BuildException( message );
|
192
|
|
}
|
193
|
|
|
194
|
0
|
if( null == m_file && m_extensionSets.isEmpty() )
|
195
|
|
{
|
196
|
0
|
final String message = "File attribute not specified.";
|
197
|
0
|
throw new BuildException( message );
|
198
|
|
}
|
199
|
0
|
if( null != m_file && !m_file.exists() )
|
200
|
|
{
|
201
|
0
|
final String message = "File '" + m_file + "' does not exist.";
|
202
|
0
|
throw new BuildException( message );
|
203
|
|
}
|
204
|
0
|
if( null != m_file && !m_file.isFile() )
|
205
|
|
{
|
206
|
0
|
final String message = "\'" + m_file + "\' is not a file.";
|
207
|
0
|
throw new BuildException( message );
|
208
|
|
}
|
209
|
|
}
|
210
|
|
}
|
211
|
|
|